From 2e75b7648c63cbe19fbb25ae7f0f88a4e40ebf31 Mon Sep 17 00:00:00 2001 From: Sascha Dobschal Date: Fri, 10 Feb 2023 16:06:48 +0100 Subject: [PATCH 1/3] add delivery milestone 1, ipfs utilities --- deliveries/ipfs_utilities-milestone_1.md | 31 ++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 deliveries/ipfs_utilities-milestone_1.md diff --git a/deliveries/ipfs_utilities-milestone_1.md b/deliveries/ipfs_utilities-milestone_1.md new file mode 100644 index 000000000..5467be03b --- /dev/null +++ b/deliveries/ipfs_utilities-milestone_1.md @@ -0,0 +1,31 @@ +# 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/Support%20Docs/milestone-deliverables-guidelines.md).** + +* **Application Document:** [IPFS Utilities application](https://github.com/w3f/Grants-Program/pull/1187/files?short_path=abcff88#diff-abcff881021fa7b4a94dd848604fd46a3a07dcff623619e0b83e6d65842d85e9) +* **Milestone Number:** 1 + +**Context** + +This delivery contains two repositories. One is providing the implementation of the IPFS integration into Substrate. The second is an example web3 client, that can be used for testing and explanations. + +For more details please check the Grant application document. + +**Deliverables** + +List of public GitHub repositories as deliverables: +* [Substrate IPFS](https://github.com/TDSoftware/substrate-ipfs/tree/milestone-1) +* [Substrate IPFS UI Client](https://github.com/TDSoftware/substrate-ipfs-ui/tree/milestone-1) + +| Number | Deliverable | Link | Notes | +| ------ | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| 0a. | License | https://github.com/TDSoftware/substrate-ipfs/blob/milestone-1/LICENSE-APACHE2 | Apache 2.0 | +| 0b. | Documentation | https://github.com/TDSoftware/substrate-ipfs/blob/milestone-1/README.md https://github.com/TDSoftware/substrate-ipfs-ui/blob/milestone-1/README.md | We provided **inline documentation** of the code, a meaningful readme for all modified modules in the repositories. | +| 0c. | Testing | https://github.com/TDSoftware/substrate-ipfs/blob/milestone-1/README.md https://github.com/TDSoftware/substrate-ipfs-ui/blob/milestone-1/README.md | Core functions are covered by unit tests as far as reasonably applicable to ensure functionality and robustness. | +| 1. | Implementation of the IPFS upload extrinsic | https://github.com/TDSoftware/substrate-ipfs/blob/milestone-1/frame/tds-ipfs/src/lib.rs | Please check the tds-ipfs and tds-ipfs-core frame module. | +| 2. | Implementation to retrieve CID and store it on chain | https://github.com/TDSoftware/substrate-ipfs/blob/milestone-1/frame/tds-ipfs/ | Offchain logic was extended to allow submitting and storing the CID on chain. | +| 3. | Implementation of a web3 client | https://github.com/TDSoftware/substrate-ipfs-ui/tree/milestone-1 | Please check the readme file for detail information. | +| 4. | Benchmark and adjustments | https://github.com/TDSoftware/substrate-ipfs-ui/tree/milestone-1 | The web3 client was used to perform benchmarking. The results will be used for further optimisations of the implementation. | + +**Additional Information** +We will continue on developing milestone 2 and will apply for another milestone (3) as we discovered potential optimisations during the benchmarking. From 54ab0b5a03c1cd4633c00067fd42978cd8d9f75a Mon Sep 17 00:00:00 2001 From: Sascha Dobschal Date: Mon, 13 Feb 2023 08:26:04 +0100 Subject: [PATCH 2/3] update application URL to correct markdown file --- deliveries/ipfs_utilities-milestone_1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deliveries/ipfs_utilities-milestone_1.md b/deliveries/ipfs_utilities-milestone_1.md index 5467be03b..f2f06a402 100644 --- a/deliveries/ipfs_utilities-milestone_1.md +++ b/deliveries/ipfs_utilities-milestone_1.md @@ -2,7 +2,7 @@ **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/Support%20Docs/milestone-deliverables-guidelines.md).** -* **Application Document:** [IPFS Utilities application](https://github.com/w3f/Grants-Program/pull/1187/files?short_path=abcff88#diff-abcff881021fa7b4a94dd848604fd46a3a07dcff623619e0b83e6d65842d85e9) +* **Application Document:** [IPFS Utilities application](https://github.com/w3f/Grants-Program/blob/master/applications/ipfs_utilities.md) * **Milestone Number:** 1 **Context** From ab3162c4d8330e4a0fe7cce331c733f0fb27d9b9 Mon Sep 17 00:00:00 2001 From: Sascha Dobschal Date: Tue, 21 Feb 2023 08:02:50 +0100 Subject: [PATCH 3/3] Update ipfs_utilities-milestone_1.md --- deliveries/ipfs_utilities-milestone_1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deliveries/ipfs_utilities-milestone_1.md b/deliveries/ipfs_utilities-milestone_1.md index f2f06a402..81e93b98d 100644 --- a/deliveries/ipfs_utilities-milestone_1.md +++ b/deliveries/ipfs_utilities-milestone_1.md @@ -21,7 +21,7 @@ List of public GitHub repositories as deliverables: | ------ | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | 0a. | License | https://github.com/TDSoftware/substrate-ipfs/blob/milestone-1/LICENSE-APACHE2 | Apache 2.0 | | 0b. | Documentation | https://github.com/TDSoftware/substrate-ipfs/blob/milestone-1/README.md https://github.com/TDSoftware/substrate-ipfs-ui/blob/milestone-1/README.md | We provided **inline documentation** of the code, a meaningful readme for all modified modules in the repositories. | -| 0c. | Testing | https://github.com/TDSoftware/substrate-ipfs/blob/milestone-1/README.md https://github.com/TDSoftware/substrate-ipfs-ui/blob/milestone-1/README.md | Core functions are covered by unit tests as far as reasonably applicable to ensure functionality and robustness. | +| 0c. | Testing | https://github.com/TDSoftware/substrate-ipfs/blob/milestone-1/README.md | Core functions are covered by unit tests as far as reasonably applicable to ensure functionality and robustness. | | 1. | Implementation of the IPFS upload extrinsic | https://github.com/TDSoftware/substrate-ipfs/blob/milestone-1/frame/tds-ipfs/src/lib.rs | Please check the tds-ipfs and tds-ipfs-core frame module. | | 2. | Implementation to retrieve CID and store it on chain | https://github.com/TDSoftware/substrate-ipfs/blob/milestone-1/frame/tds-ipfs/ | Offchain logic was extended to allow submitting and storing the CID on chain. | | 3. | Implementation of a web3 client | https://github.com/TDSoftware/substrate-ipfs-ui/tree/milestone-1 | Please check the readme file for detail information. |