Force Withdraw Tests

--- tags: Tests --- # Force Withdraw Tests <h2>Scenario 1: Too Early Force Withdraw</h2>The following scenario shows a test case where the force withdraw is too early1. The action is that the first delegator calls the behavioral action to force withdraw on the stake for stream 1 at time 4.2. Because the current time minus the oldest queue item called at time is less than the grace period, the function terminates with no further actions.<details><summary>Starting State</summary>Delegators [Delegator 1 - Funds: 0] [Delegator 2 - Funds: 0] Brokers [Broker 1 - Funds: 0] Broker Pools [Broker Pool 1 - Free Funds: 0, Pool Value: 20, Owner: Broker 1, Stake: {Stream 1: 10, Stream 2: 10}, Withdraw Queue: [(ID: Delegator 1, AMOUNT: 5.0, CALLED_AT: 0)]] Streams [Stream 1 - Stake: {Broker Pool 1: 10}] [Stream 2 - Stake: {Broker Pool 1: 10}] Vault [Vault - Internal Balances: {Delegator 1: 0, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 10}, Delegator 2: {Broker Pool 1: 10}}]</details><details><summary>Ending State</summary>Delegators [Delegator 1 - Funds: 0] [Delegator 2 - Funds: 0] Brokers [Broker 1 - Funds: 0] Broker Pools [Broker Pool 1 - Free Funds: 0, Pool Value: 20, Owner: Broker 1, Stake: {Stream 1: 10, Stream 2: 10}, Withdraw Queue: [(ID: Delegator 1, AMOUNT: 5.0, CALLED_AT: 0)]] Streams [Stream 1 - Stake: {Broker Pool 1: 10}] [Stream 2 - Stake: {Broker Pool 1: 10}] Vault [Vault - Internal Balances: {Delegator 1: 0, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 10}, Delegator 2: {Broker Pool 1: 10}}]</details><h2>Scenario 2: No Withdraw Queue</h2>The following scenario shows a test case where there is no withdraw queue so it should not trigger1. The action is that the first delegator calls the behavioral action to force withdraw on the stake for stream 1 at time 4.2. Because there are no withdraw queue items, the function terminates.<details><summary>Starting State</summary>Delegators [Delegator 1 - Funds: 0] [Delegator 2 - Funds: 0] Brokers [Broker 1 - Funds: 0] Broker Pools [Broker Pool 1 - Free Funds: 0, Pool Value: 20, Owner: Broker 1, Stake: {Stream 1: 10, Stream 2: 10}, Withdraw Queue: [(ID: Delegator 1, AMOUNT: 5.0, CALLED_AT: 0)]] Streams [Stream 1 - Stake: {Broker Pool 1: 10}] [Stream 2 - Stake: {Broker Pool 1: 10}] Vault [Vault - Internal Balances: {Delegator 1: 0, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 10}, Delegator 2: {Broker Pool 1: 10}}]</details><details><summary>Ending State</summary>Delegators [Delegator 1 - Funds: 0] [Delegator 2 - Funds: 0] Brokers [Broker 1 - Funds: 0] Broker Pools [Broker Pool 1 - Free Funds: 0, Pool Value: 20, Owner: Broker 1, Stake: {Stream 1: 10, Stream 2: 10}, Withdraw Queue: [(ID: Delegator 1, AMOUNT: 5.0, CALLED_AT: 0)]] Streams [Stream 1 - Stake: {Broker Pool 1: 10}] [Stream 2 - Stake: {Broker Pool 1: 10}] Vault [Vault - Internal Balances: {Delegator 1: 0, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 10}, Delegator 2: {Broker Pool 1: 10}}]</details><h2>Scenario 3: Full Payout</h2>The following scenario shows a test case where the withdraw queue has an overdue payment and it is paid out exactly by the steam.1. The action is that the first delegator calls the behavioral action to force withdraw on the stake for stream 1 at time 10.2. Because 10-0 > 7 (grace period), the unstaking takes place.3. Stream 1 is completely unstaked from and the withdraw queue is paid off.<details><summary>Starting State</summary>Delegators [Delegator 1 - Funds: 0] [Delegator 2 - Funds: 0] Brokers [Broker 1 - Funds: 0] Broker Pools [Broker Pool 1 - Free Funds: 0, Pool Value: 20, Owner: Broker 1, Stake: {Stream 1: 10, Stream 2: 10}, Withdraw Queue: [(ID: Delegator 1, AMOUNT: 10.0, CALLED_AT: 0)]] Streams [Stream 1 - Stake: {Broker Pool 1: 10}] [Stream 2 - Stake: {Broker Pool 1: 10}] Vault [Vault - Internal Balances: {Delegator 1: 0, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 10}, Delegator 2: {Broker Pool 1: 10}}]</details><details><summary>Ending State</summary>Delegators [Delegator 1 - Funds: 10.0] [Delegator 2 - Funds: 0] Brokers [Broker 1 - Funds: 0] Broker Pools [Broker Pool 1 - Free Funds: 0, Pool Value: 10.0, Owner: Broker 1, Stake: {Stream 1: 0, Stream 2: 10}, Withdraw Queue: []] Streams [Stream 1 - Stake: {Broker Pool 1: 0}] [Stream 2 - Stake: {Broker Pool 1: 10}] Vault [Vault - Internal Balances: {Delegator 1: 0, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 0.0}, Delegator 2: {Broker Pool 1: 10}}]</details><h2>Scenario 4: Full Payout + Early Payout</h2>The following scenario shows a test case where the withdraw queue has an overdue payment and also one that is not overdue but still gets paid off.1. The action is that the first delegator calls the behavioral action to force withdraw on the stake for stream 1 at time 10.2. Because 10-0 > 7 (grace period), the unstaking takes place.3. Stream 1 is completely unstaked from and the first withdraw queue item is paid off with 5 DATA.4. The second withdraw queue item is also paid off because there is leftover funds.<details><summary>Starting State</summary>Delegators [Delegator 1 - Funds: 0] [Delegator 2 - Funds: 0] Brokers [Broker 1 - Funds: 0] Broker Pools [Broker Pool 1 - Free Funds: 0, Pool Value: 20, Owner: Broker 1, Stake: {Stream 1: 10, Stream 2: 10}, Withdraw Queue: [(ID: Delegator 1, AMOUNT: 5.0, CALLED_AT: 0), (ID: Delegator 2, AMOUNT: 5.0, CALLED_AT: 0)]] Streams [Stream 1 - Stake: {Broker Pool 1: 10}] [Stream 2 - Stake: {Broker Pool 1: 10}] Vault [Vault - Internal Balances: {Delegator 1: 0, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 10}, Delegator 2: {Broker Pool 1: 10}}]</details><details><summary>Ending State</summary>Delegators [Delegator 1 - Funds: 5.0] [Delegator 2 - Funds: 5.0] Brokers [Broker 1 - Funds: 0] Broker Pools [Broker Pool 1 - Free Funds: 0, Pool Value: 10.0, Owner: Broker 1, Stake: {Stream 1: 0, Stream 2: 10}, Withdraw Queue: []] Streams [Stream 1 - Stake: {Broker Pool 1: 0}] [Stream 2 - Stake: {Broker Pool 1: 10}] Vault [Vault - Internal Balances: {Delegator 1: 0, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 5.0}, Delegator 2: {Broker Pool 1: 5.0}}]</details><h2>Scenario 5: Full Payout + Extra Leftover</h2>The following scenario shows a test case where the withdraw queue has an overdue payment and the unstaked funds is greater than needed.1. The action is that the first delegator calls the behavioral action to force withdraw on the stake for stream 1 at time 10.2. Because 10-0 > 7 (grace period), the unstaking takes place.3. Stream 1 is completely unstaked from and the first withdraw queue item is paid off with 5 DATA.4. The leftover 5 funds is released to free funds.<details><summary>Starting State</summary>Delegators [Delegator 1 - Funds: 0] [Delegator 2 - Funds: 0] Brokers [Broker 1 - Funds: 0] Broker Pools [Broker Pool 1 - Free Funds: 0, Pool Value: 20, Owner: Broker 1, Stake: {Stream 1: 10, Stream 2: 10}, Withdraw Queue: [(ID: Delegator 1, AMOUNT: 5.0, CALLED_AT: 0)]] Streams [Stream 1 - Stake: {Broker Pool 1: 10}] [Stream 2 - Stake: {Broker Pool 1: 10}] Vault [Vault - Internal Balances: {Delegator 1: 0, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 10}, Delegator 2: {Broker Pool 1: 10}}]</details><details><summary>Ending State</summary>Delegators [Delegator 1 - Funds: 5.0] [Delegator 2 - Funds: 0] Brokers [Broker 1 - Funds: 0] Broker Pools [Broker Pool 1 - Free Funds: 5.0, Pool Value: 15.0, Owner: Broker 1, Stake: {Stream 1: 0, Stream 2: 10}, Withdraw Queue: []] Streams [Stream 1 - Stake: {Broker Pool 1: 0}] [Stream 2 - Stake: {Broker Pool 1: 10}] Vault [Vault - Internal Balances: {Delegator 1: 0, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 5.0}, Delegator 2: {Broker Pool 1: 10}}]</details>