From 3098a25c9066ae322d0a6b1e34c0b5d1f2fe8865 Mon Sep 17 00:00:00 2001 From: Xavier Lau Date: Sat, 24 Jun 2023 02:59:48 +0800 Subject: [PATCH] Slothunter milestone 1 --- deliveries/slothunter-milestone_1.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 deliveries/slothunter-milestone_1.md diff --git a/deliveries/slothunter-milestone_1.md b/deliveries/slothunter-milestone_1.md new file mode 100644 index 000000000..24b861db8 --- /dev/null +++ b/deliveries/slothunter-milestone_1.md @@ -0,0 +1,21 @@ +# Milestone Delivery :mailbox: + +**The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/milestone-deliverables-guidelines.md).** + +* **Application Document:** [Slothunter](https://github.com/w3f/Grants-Program/blob/master/applications/slothunter.md) +* **Milestone Number:** 1 + +**Deliverables** +| Number | Deliverable | Specification | +| -----: | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 0a. | License | GPLv3 | +| 0b. | Documentation | There will be a guide to tell people how to use this. | +| 0c. | Testing guide | There will be a docker file and a guide to tell the auditor how to run the tests. It will guide you how to setup an auction and do the tests. | +| 1. | Auction winner calculator | Based on the 0c., run the binary, you should see the current winner from the terminal log. | +| 2. | Notification component | Based on the 0c., run the binary, you should receive these notification correctly. | +| 3. | Auto bidding/contributing component | Based on the 0c., run the binary, you should see you are bidding/contributing your parathread from the Polkadot Apps. | +| 4. | Slothunter configuration component | Based on the 3., you can customize your bidding/contributing strategy in a toml file, you should see your bidding/contributing behavior works the same as the strategy defined. | +| 5. | Releases | Linux, macOS, Windows prebuilt binaries, and crates.io release. | + +**Additional Information** +Please follow the [guide](https://github.com/hack-ink/slothunter/blob/main/test/guide.md) to test Slothunter.