Set Existential Deposit to Zero and Refactor Related Tests #170

asiniscalchi · 2023-11-10T14:10:51Z

PR Type:

Refactoring

PR Description:

This PR primarily focuses on setting the Existential Deposit to zero and refactoring the related tests. The main changes include:

The Existential Deposit, which is the minimum amount required to keep an account open, is set to zero.
The candidacy bond in the collator selection configuration is also set to zero.
The tests have been refactored to reflect these changes, including a new test to ensure the minimum balance is zero.
The 'pallet-balances' feature 'insecure_zero_ed' has been enabled in the runtime's Cargo.toml file.

PR Main Files Walkthrough:

files:

ownership-chain/node/src/chain_spec.rs: The candidacy bond in the collator selection configuration is set to zero.
ownership-chain/runtime/src/lib.rs: The Existential Deposit is set to zero, with an explanation of the reasons for this change.
ownership-chain/runtime/src/tests.rs: Tests have been added and refactored to reflect the changes in the Existential Deposit and candidacy bond.
ownership-chain/runtime/Cargo.toml: The 'pallet-balances' feature 'insecure_zero_ed' has been enabled.

asiniscalchi · 2023-11-10T14:11:00Z

/describe

asiniscalchi · 2023-11-10T14:11:05Z

/review

…seio/laos into feature/existential_deposit_is_0

asiniscalchi · 2023-11-10T14:15:03Z

/describe

asiniscalchi · 2023-11-10T14:15:08Z

/review

asiniscalchi · 2023-11-10T16:07:43Z

/describe

asiniscalchi · 2023-11-13T10:16:22Z

/describe

ghost

there is e2e test missing as per acceptance criteria:

I see an account existing with 1e-18 DROP
I can transfer 1e-18 DROP to an account that had no balance, and check it has 1Wei

ghost · 2023-11-13T10:25:06Z

ownership-chain/node/src/chain_spec.rs

@@ -181,7 +181,7 @@ fn testnet_genesis(
 		},
 		collator_selection: laos_ownership_runtime::CollatorSelectionConfig {
 			invulnerables: invulnerables.iter().cloned().map(|(acc, _)| acc).collect(),
-			candidacy_bond: EXISTENTIAL_DEPOSIT * 16,
+			candidacy_bond: laos_ownership_runtime::ExistentialDeposit::get() * 16,


we are requiring 0 bond for candidacy to be a collator? This should be a non-zero value, IMO

please open an issue on the topic

I think, if you are changing something in the code, then everything that depends on this constant should be addressed as well. I suggest at least creating a new constant that does not depend on the ED anymore. Value can be calculated with previous non-zero value of ED

16 * PREVIOUS_ED

ownership-chain/runtime/src/lib.rs

ownership-chain/runtime/src/tests.rs

ghost · 2023-11-13T10:37:52Z

ownership-chain/runtime/src/tests.rs

+		let result = Balances::deposit(&alice, minimum_amount, Precision::Exact);
+
+		// I am forced to use match cause result doesn't implement Debug trait
+		match result {


assert_ok!() didn't work?

yes it doesn't because it needs Debug trait to be implemented

assert!(Balances::deposit(&alice, minimum_amount, Precision::Exact).is_ok());

Co-authored-by: dastan <[email protected]>

ownership-chain/runtime/src/tests.rs

ghost · 2023-11-13T14:43:15Z

ownership-chain/runtime/src/tests.rs

+		let result = Balances::deposit(&alice, minimum_amount, Precision::Exact);
+
+		// I am forced to use match cause result doesn't implement Debug trait
+		match result {


assert!(Balances::deposit(&alice, minimum_amount, Precision::Exact).is_ok());

ownership-chain/runtime/src/tests.rs

ownership-chain/runtime/src/lib.rs

ghost · 2023-11-13T14:56:32Z

ownership-chain/node/src/chain_spec.rs

@@ -181,7 +181,7 @@ fn testnet_genesis(
 		},
 		collator_selection: laos_ownership_runtime::CollatorSelectionConfig {
 			invulnerables: invulnerables.iter().cloned().map(|(acc, _)| acc).collect(),
-			candidacy_bond: EXISTENTIAL_DEPOSIT * 16,
+			candidacy_bond: laos_ownership_runtime::ExistentialDeposit::get() * 16,


I think, if you are changing something in the code, then everything that depends on this constant should be addressed as well. I suggest at least creating a new constant that does not depend on the ED anymore. Value can be calculated with previous non-zero value of ED

16 * PREVIOUS_ED

asiniscalchi · 2023-11-14T10:25:17Z

I didn't see that the value of candidacy_bond was not protected from a possible existential deposit of 0 .. I fixed it to avoid it to be 0.

ghost

looks good.

only 2 really small nitpicks

ghost · 2023-11-14T10:39:47Z

ownership-chain/node/src/chain_spec.rs

@@ -181,7 +181,7 @@ fn testnet_genesis(
 		},
 		collator_selection: laos_ownership_runtime::CollatorSelectionConfig {
 			invulnerables: invulnerables.iter().cloned().map(|(acc, _)| acc).collect(),
-			candidacy_bond: EXISTENTIAL_DEPOSIT * 16,
+			candidacy_bond: laos_ownership_runtime::ExistentialDeposit::get() * 16 + 1,


the first part of multiplication resolves to 0 anyway

Suggested change

candidacy_bond: laos_ownership_runtime::ExistentialDeposit::get() * 16 + 1,

candidacy_bond: laos_ownership_runtime::WEI,

Issues with Using laos_ownership_runtime::WEI for candidacy_bond

Contextual Inappropriateness:

WEI, as a denomination, is specific to Ethereum.

Potential Inconsistency with ExistentialDeposit:

Setting the candidacy_bond to a constant value like WEI could create a situation where it is less than the ExistentialDeposit. Such a discrepancy could lead to undesired behaviors.

Contextual Inappropriateness:

I agree that WEI is not completely appropriate, but I suggested it for the sake of having some relation to constants defined in the runtime. Ideally, there should be a visible pub const COLLATOR_CANDIDACY_BOND: u128 in the runtime or the value should be at least tied to a constant in the runtime. In any case, using WEI is still better than having simply 1, imo.

Potential Inconsistency with ExistentialDeposit:

the point of the PR is to make ED zero, why would there be a situation where candidacy_bond is less than zero?

We concur that using WEI is inappropriate due to its lack of direct relevance in a Substrate context.

Regarding the use of a constant, it's crucial to maintain the dependency of candidacy_bond on ExistentialDeposit. Even if ExistentialDeposit is set to zero in current configuration, using a fixed constant for candidacy_bond introduces a risk. This approach could lead to a problematic situation in scenarios where the runtime is configured with an ExistentialDeposit greater than zero. In such cases, the candidacy_bond might inadvertently fall below the ExistentialDeposit, leading to unintended consequences. Therefore, tying candidacy_bond to a dynamic value like ExistentialDeposit is more robust and adaptable to different runtime configurations.

it's crucial to maintain the dependency of candidacy_bond on ExistentialDeposit. Even if ExistentialDeposit is set to zero in current configuration, using a fixed constant for candidacy_bond introduces a risk.

why is it "crucial" to maintain dependency and why there should be a dependency? ED was simply used because there was a need to have some unambiguous value. There is no special relationship between candidacy_bond and ED. In the same way, you can use UNIT or any other constant from runtime to derive the value of candidacy_bond.

in any case, I looked at other parachains, some set it to a big value, like astar:

https://github.com/AstarNetwork/Astar/blob/35f6433780025c7e4012afecb6cb3682ca249bd7/bin/collator/src/parachain/chain_spec/astar.rs#L137

some others set it to 0:

https://github.com/AcalaNetwork/Acala/blob/cab5cd8a8f234a0931bec4a854e805fdb896ffc6/node/service/src/chain_spec/acala.rs#L209

So, I suggest we either have it explicitly as Zero::zero() or have some non-zero value defined clearly

ownership-chain/runtime/src/tests.rs

asiniscalchi · 2023-11-14T16:39:51Z

/describe

asiniscalchi · 2023-11-15T09:56:40Z

/describe

ghost · 2023-11-15T10:37:31Z

ownership-chain/runtime/src/tests.rs

+}
+
+#[test]
+fn deposit_smallest_unit_should_succeed() {


I think with send_1_wei_to_wallet_with_0_balance_should_increase_balance_by_1_wei, this test becomes unnecessary, since all the actions/checks that are done here is done in send_1_wei_to_wallet_with_0_balance_should_increase_balance_by_1_wei as well

ghost · 2023-11-15T10:42:19Z

ownership-chain/node/src/chain_spec.rs

@@ -181,7 +181,7 @@ fn testnet_genesis(
 		},
 		collator_selection: laos_ownership_runtime::CollatorSelectionConfig {
 			invulnerables: invulnerables.iter().cloned().map(|(acc, _)| acc).collect(),
-			candidacy_bond: EXISTENTIAL_DEPOSIT * 16,
+			candidacy_bond: laos_ownership_runtime::ExistentialDeposit::get() + 1,


my initial comment about this was wrong, this can actually be Zero::zero() and doesn't need to be a non-zero value. Assuming that, can we set this to either:

bigger explicit value, sth like UNIT * 16

or to Zero::zero() explicitly

I am just suggesting it since it seems this is how other parachains are doing it. At the very least, I am ok with having it simply 1, tying it to ED doesn't really make much sense to me though

https://github.com/AstarNetwork/Astar/blob/35f6433780025c7e4012afecb6cb3682ca249bd7/bin/collator/src/parachain/chain_spec/astar.rs#L137

https://github.com/AcalaNetwork/Acala/blob/cab5cd8a8f234a0931bec4a854e805fdb896ffc6/node/service/src/chain_spec/acala.rs#L209

sgtm: the zero option is nice and already tested in other blockchain

asiniscalchi · 2023-11-15T11:11:53Z

/describe

asiniscalchi added 2 commits November 10, 2023 10:24

create the test

baf5110

existential deposit to 1

9de068c

Merge branch 'main' into feature/existential_deposit_is_0

f3b3a49

github-actions bot changed the title ~~Feature/existential deposit is 0~~ Update Existential Deposit to 1 and Add Related Tests Nov 10, 2023

asiniscalchi added 3 commits November 10, 2023 15:12

removed tests not necessary

6e669c3

Merge branch 'feature/existential_deposit_is_0' of github.com:freever…

b58bbf9

…seio/laos into feature/existential_deposit_is_0

refactoring

0419844

asiniscalchi linked an issue Nov 10, 2023 that may be closed by this pull request

Set Existential Deposit to 0 #165

Closed

freeverseio deleted a comment from github-actions bot Nov 10, 2023

github-actions bot changed the title ~~Update Existential Deposit to 1 and Add Related Tests~~ Update Existential Deposit to 1 and Refactor Related Tests Nov 10, 2023

freeverseio deleted a comment from github-actions bot Nov 10, 2023

refactoring

0bfa523

asiniscalchi self-assigned this Nov 10, 2023

asiniscalchi marked this pull request as draft November 10, 2023 16:01

using existential balance == 0

e7b23ab

asiniscalchi marked this pull request as ready for review November 10, 2023 16:07

fmt

7266d95

github-actions bot changed the title ~~Update Existential Deposit to 1 and Refactor Related Tests~~ Update Existential Deposit to 0 and Refactor Related Tests Nov 10, 2023

asiniscalchi marked this pull request as draft November 10, 2023 19:01

asiniscalchi added 3 commits November 13, 2023 09:40

fix compilation error

c773ed7

add test for minimum amount

f2c557f

fmt

ba7e5bc

asiniscalchi marked this pull request as ready for review November 13, 2023 10:16

ghost suggested changes Nov 13, 2023

View reviewed changes

asiniscalchi and others added 4 commits November 13, 2023 12:51

Update ownership-chain/runtime/src/tests.rs

8ba1833

Co-authored-by: dastan <[email protected]>

better commnet

5ccfa29

Merge branch 'main' into feature/existential_deposit_is_0

5dc42de

fix the merge

8a5d78f

ghost reviewed Nov 13, 2023

View reviewed changes

asiniscalchi added 6 commits November 14, 2023 10:50

better test name

c8da0a8

comment identation

f68dd61

using assert! in test

25c9ddc

protect the candidacy_bond from a 0 Esitential deposit

c1aeab6

some consmetics

67cd3c0

Merge branch 'main' into feature/existential_deposit_is_0

3e64cc7

ghost previously approved these changes Nov 14, 2023

View reviewed changes

fmt

812813e

asiniscalchi dismissed ghost ’s stale review via 812813e November 14, 2023 11:50

not needed to have a candidacy bond so high

241474f

github-actions bot changed the title ~~Update Existential Deposit to 0 and Refactor Related Tests~~ Update Existential Deposit to Zero and Refactor Related Tests Nov 14, 2023

asiniscalchi marked this pull request as draft November 14, 2023 16:52

move e2e test -> unit test

614f9ba

asiniscalchi marked this pull request as ready for review November 15, 2023 09:56

github-actions bot changed the title ~~Update Existential Deposit to Zero and Refactor Related Tests~~ Set Existential Deposit to Zero and Refactor Related Tests Nov 15, 2023

ghost reviewed Nov 15, 2023

View reviewed changes

removed unuseful test

bbe24de

ghost approved these changes Nov 15, 2023

View reviewed changes

Merge branch 'main' into feature/existential_deposit_is_0

db07a6a

asiniscalchi merged commit 8a92e9c into main Nov 15, 2023
7 checks passed

asiniscalchi deleted the feature/existential_deposit_is_0 branch November 15, 2023 13:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set Existential Deposit to Zero and Refactor Related Tests #170

Set Existential Deposit to Zero and Refactor Related Tests #170

asiniscalchi commented Nov 10, 2023 •

edited by github-actions bot

Loading

asiniscalchi commented Nov 10, 2023

asiniscalchi commented Nov 10, 2023

asiniscalchi commented Nov 10, 2023

asiniscalchi commented Nov 10, 2023

asiniscalchi commented Nov 10, 2023

asiniscalchi commented Nov 13, 2023

ghost left a comment

ghost Nov 13, 2023

asiniscalchi Nov 13, 2023

ghost Nov 13, 2023

ghost Nov 13, 2023

asiniscalchi Nov 13, 2023

ghost Nov 13, 2023

ghost Nov 13, 2023

ghost Nov 13, 2023

asiniscalchi commented Nov 14, 2023

ghost left a comment

ghost Nov 14, 2023

asiniscalchi Nov 14, 2023 •

edited

Loading

ghost Nov 14, 2023 •

edited by ghost

Loading

asiniscalchi Nov 14, 2023

ghost Nov 14, 2023 •

edited by ghost

Loading

asiniscalchi commented Nov 14, 2023

asiniscalchi commented Nov 15, 2023

ghost Nov 15, 2023

asiniscalchi Nov 15, 2023

ghost Nov 15, 2023

asiniscalchi Nov 15, 2023

asiniscalchi commented Nov 15, 2023

	candidacy_bond: laos_ownership_runtime::ExistentialDeposit::get() * 16 + 1,
	candidacy_bond: laos_ownership_runtime::WEI,

Set Existential Deposit to Zero and Refactor Related Tests #170

Set Existential Deposit to Zero and Refactor Related Tests #170

Conversation

asiniscalchi commented Nov 10, 2023 • edited by github-actions bot Loading

PR Type:

PR Description:

PR Main Files Walkthrough:

asiniscalchi commented Nov 10, 2023

asiniscalchi commented Nov 10, 2023

asiniscalchi commented Nov 10, 2023

asiniscalchi commented Nov 10, 2023

asiniscalchi commented Nov 10, 2023

asiniscalchi commented Nov 13, 2023

ghost 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

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

asiniscalchi commented Nov 14, 2023

ghost left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asiniscalchi Nov 14, 2023 • edited Loading

Choose a reason for hiding this comment

Issues with Using laos_ownership_runtime::WEI for candidacy_bond

ghost Nov 14, 2023 • edited by ghost Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost Nov 14, 2023 • edited by ghost Loading

Choose a reason for hiding this comment

asiniscalchi commented Nov 14, 2023

asiniscalchi commented Nov 15, 2023

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

asiniscalchi commented Nov 15, 2023

asiniscalchi commented Nov 10, 2023 •

edited by github-actions bot

Loading

asiniscalchi Nov 14, 2023 •

edited

Loading

Issues with Using `laos_ownership_runtime::WEI` for `candidacy_bond`

ghost Nov 14, 2023 •

edited by ghost

Loading

ghost Nov 14, 2023 •

edited by ghost

Loading