Test suite for `Tick`, `Wind`, `Ring`

[alan890104]

Although the reward mechanism is not implemented, its logic will not effect the basic tests. Tests include but not restricted to the below check lists, feel free to provide more testing idea here:

NOTE:

1. remaining funds includes TON and jettons
2. always check balance after each operation related to transfer asset

Tick

Tick message open a quote position for a watchmaker.

• [x] Should parse Tick payload from Jetton Internal Transfer
• [x] Should return funds if remaining ton is sufficient to pay the gas
  • [x] Invalid jetton token received
  • [x] Amount is lower than the lowerbound (theshold for baseAsset + gas)
• [x] Should fail if message is not from oracle
• [x] Should deploy Alarm contract and initialize it correctly
  • [x] Alarm index should increased by 1
  • [x] Should preserve correct amount of baseAsset in Oracle
• [x] Should return funds after deploying alarm contract

Wind

Wind message takes profit from specified Alarm contract, and open a new position with doubled assets

• [x] Should parse Wind payload from Jetton Internal Transfer
• [x] Should return funds if side or alarmIndex is incorrect
• [x] Should send reset message to corresponding alarm contract
  • [x] if remain scale is 0 or asset scale is lower than requested number to buy, return remaining funds back to TimeKeeper
• [x] Should fail transaction if Reset message is not from Oracle
• [x] Should fail transaction if Chime message not came from Alarm contract
• [x] Should send Chime message back to oracle if success
  • [x] Should update price according to the formula
  • [x] Should not update price if remain scale is 0 or the interval is smaller or equal than timePace
  • [x] Should deploy a new Alarm contract with correct parameter
  • [x] Should increase alarm index if new Alarm contract is deployed
  • [x] Should return remaining funds with profits with comment Slickback to TimeKeeper

Ring

• [x] Should fail if alarm index does not exists
• [x] Should send Mute message to corresponding Alarm contract
• [x] Should failed if Mute message is not from oracle
• [x] Should send Chronoshift to oracle with remaining balance
  • [x] Should alarm contract be destroyed
• [x] Should fail transaction if Chronoshift is not from alarm contract
• [x] Should update price if remain scale is not zero
• [x] Should not update price if remain scale is zero or the interval is smaller or equal than timePace
• [x] Should return remaining funds back to Watchmaker

[ipromise2324]

Tick Test:

1. In the receive(msg: JettonTransferNotification) function of the Oracle contract, code for returning Jettons to the user was not written.
2. In the receive(msg: JettonTransferNotification), I added a sendBackAmount variable to record how much money needs to be returned to the user after building alarm successfully. Also, I changed the mode to SendIgnoreErrors and set the value to sendBackAmount in the receive(msg: JettonTransferNotification).
3. In the receive(msg: JettonTransferNotification), needBaseAssetAmount = msg.amount.float() / baseAssetPrice; After calculation, it needs to be multiplied by 10**9 to represent the amount of ton to be transferred (e.g., 10/2.5 = 4, which means 4 tons, therefore 4 should be multiplied by Decimal)
4. In the Alarm contract, I modified requireNotInitialized to self.watchmaker == newAddress(0, 0). This means that if watchmaker.address == 0x00, it indicates that the alarm has not been initialized yet (originally it was judged by self.oracleAddress == newAddress(0, 0)).

[ipromise2324]

Wind Test:

1. In the receive(msg: Reset) function, I changed the require(self.remainScale > msg.buyNum, "Not enough scale to buy"); to >=, to allow the Timekeeper to buy all of the remainScale.
2. In the receive(msg: JettonTransferNotification) function, within if(opCode == 1), the Reset message's sender is msg.sender (timekeeper), not ctx.sender (oracle jetton wallet).
3. In the receive(msg: Chime) function, when deploying a new alarm, a basic value is required to build the contract. I have currently hardcoded it as 0.05 ton.
4. In the receive(msg: Chime) function, after building the alarm, totalAlarms is not incremented by 1.
5. When the timekeeper sends the wind message, it does not specify the new price to be offered, therefore there is no check to see if the jettons and tons sent are sufficient for this quotation.
6. In the receive(msg: Reset) function, baseAssetPrice is not overwritten with a new value. It should be changed to the new price as perceived by the timekeeper. Currently, it is 0, so the baseAssetPrice for the new alarm built by the timekeeper is also 0.
7. In the receive(msg: Chime) function, in addition to checking if msg.remainScale > 0, should there also be a check to see if the verification stage has passed? Only if it has passed, the price can be changed.
8. In receive(msg: Reset), if require(self.remainScale >= msg.buyNum, "Not enough scale to buy") is not met, the jettons are not returned to the timekeeper.

[skyline9981]

1. Didn't check if Chronoshift is from alarm contract, so the test is failed.
2. Didn't check the time pace when watchmaker send ring msg to the oracle.
3. Should find a way to change blockchain logic time when testing.

[ipromise2324]

Bugs:

In receive(msg: Reset):

• [x] needQuoteAssetAmount is always zero, so that msg.quoteAssetAmount - needQuoteAssetAmount' is >= 0 and timekeeper can buy base asset anyway.
• [x] Didn't check ctx.value > needBaseAssetAmount, so that it can't make sure that timekeeper brought enough ton to buy quote asset.
• [ ] Don't return jetton if the oracle is not initialized
• [x] needBaseAssetAmount * MIN_BASEASSET_TRESHOLD >= MIN_BASEASSET_TRESHOLD should be needBaseAssetAmount >= MIN_BASEASSET_TRESHOLD

In receive(msg: Chime):

• [x] It will deploy a new alarm contract anyway. It have to check that timekeeper bought asset and bring enough money to deploy a new alarm contract.
• [x] When sending refundQuoteAssetAmount, we should send the remaining funds in forward_ton_amount back to the TimeKeeper and not to use SendRemainingValue mode

[ipromise2324]

Test Cases:

Tick Test Add:

• [x] should send Jetton back if currentTimestamp > expireAt
• [x] Should revert if baseAssetAmount is too small
• [x] Should revert if insufficient funds to pay for the gas

Wind Test Add:

• [x] Should revert if self.remainScale < msg.buyNum
• [x] Should timekeeper buy quoteAsset
• [x] Should timekeeper buy baseAsset
• [x] Should buy base asset with not enough quote asset
• [x] Should buy quote asset with not enough base asset
• [x] Should refund quote asset back to timekeeper if he bring to much quote asset
• [x] Should refund base asset back to timekeeper if he bring to much base asset
• [x] Should timekeeper wind but don't have to transfer any quote asset to oracle in the first place

Ring Test Add:

• [x] Should transfer the remaining quote token back to watchmaker -> if (msg.remainQuoteAssetScale > 0)
• [x] Should transfer the remaining base asset back to watchmaker -> else if (msg.remainBaseAssetScale > 0)