Withdraw Queue Tests

--- tags: Tests --- # Withdraw Queue Tests <h2>Scenario 1: Only Withdraw Queue</h2>The following scenario shows a test case where there are no free funds leads to a creation of a withdraw queue object only.The action is that the first delegator calls the behavioral action to withdraw all 10 of their tokens. This ends up creating a 10 token withdraw queue item because none of it can be paid out.<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: []] 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: 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><h2>Scenario 2: Half Withdraw Queue Half Immediate Withdraw</h2>The following scenario shows a test case where there are some free funds but no enough to cover the entire withdrawal so a withdraw queue item is still created.1. The first delegator withdraws 10 tokens.2. The amount of DATA needed to pay off the entire 10 tokens is 10, but the free funds is only 5.3. The 5 DATA is paid out to the internal balance for delegator 1. The pool value and free funds both decrease by 5. The delegator 1 token balance goes to 5.4. A withdraw queue item is added for the remaining 5.<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: 5, Pool Value: 20, Owner: Broker 1, Stake: {Stream 1: 5, Stream 2: 10}, Withdraw Queue: []] Streams [Stream 1 - Stake: {Broker Pool 1: 5}] [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: 15, Owner: Broker 1, Stake: {Stream 1: 5, Stream 2: 10}, Withdraw Queue: [(ID: Delegator 1, AMOUNT: 5.0, CALLED_AT: 0)]] Streams [Stream 1 - Stake: {Broker Pool 1: 5}] [Stream 2 - Stake: {Broker Pool 1: 10}] Vault [Vault - Internal Balances: {Delegator 1: 5, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 5.0}, Delegator 2: {Broker Pool 1: 10}}]</details><h2>Scenario 3: Full Immediate Payout</h2>The following scenario shows a test case where there are enough free funds to completely pay off a delegator withdraw.1. The first delegator withdraws 10 tokens.2. The amount of DATA needed to pay off the entire 10 tokens is 10, and free funds is 10.3. The 10 DATA is paid out to the internal balance for delegator 1. The pool value and free funds both decrease by 10. The delegator 1 token balance goes to 0. 4. A withdraw queue item is added for the remaining 5.<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: 10, Pool Value: 20, 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: 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: 10, 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: 10, Delegator 2: 0}, Token Balances: {Delegator 1: {Broker Pool 1: 0.0}, Delegator 2: {Broker Pool 1: 10}}]</details>