forked from w3f/Grant-Milestone-Delivery
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'w3f:master' into master
- Loading branch information
Showing
7 changed files
with
196 additions
and
119 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# 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:** [SubIdentity Application](https://github.com/w3f/Grants-Program/blob/master/applications/SubIdentity.md) | ||
* **Milestone Number:** 1 | ||
|
||
**Context** | ||
|
||
A basic application with a responsive design was developed which supports querying by address and identity fields. A user can, by default, query identities from Polkadot, Kusama or Westend. After a search is done, a list view with all results is displayed. An identity can be selected from the list by clicking on the table row. This is to present its details in an identity view. The SubIdentity web application uses the SubIdentity npm package to search for identities on a given node. The SubIdentity package contains required methods and interfaces for the SubIdentity web application to search for identities on a substrate based chain implementing the identity pallet. | ||
|
||
**Deliverables** | ||
|
||
Deliverables are two Github repositories: | ||
* [web application](https://github.com/TDSoftware/subidentity-webapp) | ||
* [package](https://github.com/TDSoftware/subidentity-package) | ||
|
||
Feel free to use the main branches for reviewing. | ||
|
||
| Number | Deliverable | Link | Notes | | ||
| ------------- | ------------- | ------------- |------------- | | ||
| 0a. | License | https://github.com/TDSoftware/subidentity-package/blob/main/LICENSE https://github.com/TDSoftware/subidentity-webapp/blob/main/LICENSE | Apache 2.0 | | ||
| 0b. | Documentation | https://github.com/TDSoftware/subidentity-webapp/blob/main/README.md https://github.com/TDSoftware/subidentity-webapp/blob/main/docs/Tutorial.md https://github.com/TDSoftware/subidentity-package/blob/main/README.md | We provided **inline documentation** of the code, a meaningful readme and added a basic **tutorial** that explains how a user can use the application. | | ||
| 0c. | Testing | https://github.com/TDSoftware/subidentity-webapp/blob/main/README.md https://github.com/TDSoftware/subidentity-package/blob/main/README.md | Core functions are covered by unit tests as far as reasonably applicable to ensure functionality and robustness. In the readme files, we describe how to run these tests. | | ||
| 1. | Concept and design | https://www.figma.com/file/Rn8xSxi3flRBJ0Nf0GKWeK/SubIdentity-Public?node-id=0%3A1 | We created a high-fidelity, responsive, pixel perfect design for a search view, a list view and a detailed identity view. | | ||
| 2. | Implement logic for querying identities | https://github.com/TDSoftware/subidentity-package/blob/main/src/identities.ts | We implement the logic to receive identities from a substrate-based chain implementing the Identity pallet in a npm package. | | ||
| 3. | Implement UI for search and list view | https://github.com/TDSoftware/subidentity-webapp/blob/main/src/views/SearchView.vue https://github.com/TDSoftware/subidentity-webapp/blob/main/src/views/ListView.vue | Build UI with Vue.js | | ||
| 4. | Implement UI for detailed identity view | https://github.com/TDSoftware/subidentity-webapp/blob/main/src/views/IdentityView.vue | The identity view can easily be extended with custom plugins. A detailed description can be found in the [readme](https://github.com/TDSoftware/subidentity-webapp/blob/main/README.md). | | ||
|
||
**Additional Information** | ||
|
||
A web application with the core functionality was developed as part of milestone 1 and is hosted at https://subidentity.tdsoftware.de/. Next we will focus on implementing the deliverables for Milestone 2, while also looking to fix some open design issues. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# 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:** [Asylum](https://github.com/w3f/Grants-Program/tree/master/applications/asylum.md). | ||
* **Milestone Number:** e.g. 1 | ||
|
||
**Context** | ||
|
||
The first milestone covers: | ||
- the on-chain pallets implementation of NFT-item standards; | ||
- web app integrated with on-chain to configure NFT-items and basic Game entities. | ||
|
||
**Deliverables** | ||
|
||
| Number | Deliverable | Link | Notes | | ||
| ------------- | ------------- | ------------- |------------- | | ||
| 0a. | License | [Asylum UI](https://gitlab.com/asylum-space/asylum-ui/-/blob/main/LICENSE), [Asylum Item NFT](https://gitlab.com/asylum-space/asylum-item-nft/-/blob/main/LICENSE) | All Asylum projects have MIT license| | ||
| 0b. | Documentation |[Asylum Core Pallet](https://gitlab.com/asylum-space/asylum-item-nft/-/blob/main/pallets/asylum-core/README.md), [Asylum Game Distribution System Pallet](https://gitlab.com/asylum-space/asylum-item-nft/-/blob/main/pallets/asylum-game-distribution/README.md)| Asylum core pallet utilises [`RMRK`](https://rmrk-team.github.io/rmrk-substrate/#/pallets/rmrk-core) and [`pallet_uniques`](https://docs.rs/pallet-assets/latest/pallet_uniques/) and manages NFT semantics, metadata, and transferability. Game Distribution System pallet manages the Game entity: metadata, game pass, associated game client.| | ||
| 0c. | Testing Guide |[Asylum pallets testing guide](https://gitlab.com/asylum-space/asylum-item-nft/-/blob/main/docs/testing-guide.md), [Connection Library testing guide](https://gitlab.com/asylum-space/asylum-ui/-/blob/main/packages/connection-library/docs/testing-guide.md), [Game Developers Console testing guide](https://gitlab.com/asylum-space/asylum-ui/-/blob/main/packages/game-developers-console/docs/testing-guide.md) |<ol>There are 3 options to interact with Asylum node: <li>PolkadotJS app </li> <li>Asylum UI/Connection Library npm package</li> <li>Asylum UI/Game Developer Console web app</li></ol> | | ||
|1.| Item standard definition | [Asylum flow diagram](https://gitlab.com/asylum-space/asylum-item-nft/-/blob/main/docs/img/asylum-flow-diagram.png), [Asylum Standard 0.1](https://gitlab.com/asylum-space/asylum-standards/-/blob/main/standards/asylum0.1/README.md) | All NFT items in Asylum ecosystem extends pallet_uniques and RMRK standards and inherits tranferability and extensibility. But we want also to bring gaming semantics and interoperability to items, that's why we introduced such abstractions as Template and Interpretation. Asylum Core pallet manages these entities. | | ||
|1.1| 2D visualization | [Configure Template and Interpretations (Testing Guide)](https://gitlab.com/asylum-space/asylum-ui/-/blob/main/packages/game-developers-console/docs/testing-guide.md#step-3-configure-template-and-interpretations) | Every Template in Asylum can have multiple visual (as well as 2D) representations. The [Step 3](https://gitlab.com/asylum-space/asylum-ui/-/blob/main/packages/game-developers-console/docs/testing-guide.md#step-3-configure-template-and-interpretations) of Testing Guide describes it in details. | | ||
|1.2| 3D visualization | [Configure Template and Interpretations (Testing Guide)](https://gitlab.com/asylum-space/asylum-ui/-/blob/main/packages/game-developers-console/docs/testing-guide.md#step-3-configure-template-and-interpretations) | Every Template in Asylum can have multiple visual (as well as 3D) representations. The [Step 3](https://gitlab.com/asylum-space/asylum-ui/-/blob/main/packages/game-developers-console/docs/testing-guide.md#step-3-configure-template-and-interpretations) of Testing Guide describes it in details. | | ||
|1.3| Multiple visual interpretations | [Configure Template and Interpretations (Testing Guide)](https://gitlab.com/asylum-space/asylum-ui/-/blob/main/packages/game-developers-console/docs/testing-guide.md#step-3-configure-template-and-interpretations) | Every Template in Asylum can have multiple visual (and not only visual) representations. The [Step 3](https://gitlab.com/asylum-space/asylum-ui/-/blob/main/packages/game-developers-console/docs/testing-guide.md#step-3-configure-template-and-interpretations) of Testing Guide describes it in details. | | ||
|2.| Asylum Core Pallet | [Asylum Core Pallet](https://gitlab.com/asylum-space/asylum-item-nft/-/blob/main/pallets/asylum-core), [Asylum pallets testing guide](https://gitlab.com/asylum-space/asylum-item-nft/-/blob/main/docs/testing-guide.md) | Asylum Core Pallet provides NFT items transferability and ability to manage items metadata and representation for different contexts of usage | | ||
|3.| Connection Library | [Asylum UI/Connection Library](https://gitlab.com/asylum-space/asylum-ui/-/tree/main/packages/connection-library), [Testing guide](https://gitlab.com/asylum-space/asylum-ui/-/blob/main/packages/connection-library/docs/testing-guide.md) | Asylum Connection Library is a typescript library in the form of npm package, which eases integration with Asylum pallets providing clear API | | ||
|4.| Web Application | [Asylum UI/Game developers console](https://gitlab.com/asylum-space/asylum-ui/-/tree/main/packages/game-developers-console), [Testing guide](https://gitlab.com/asylum-space/asylum-ui/-/blob/main/packages/game-developers-console/docs/testing-guide.md) | Web app, written in React and designed for game developers to create and manage Asylum entities: create item templates, manage interpetations, mint NFTs.| |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# 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.** | ||
|
||
* **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/php-rpc-lib.md | ||
* **Milestone Number:** 2 | ||
|
||
Please provide a list of all deliverables of the milestone extracted from the initial application and a link to the | ||
deliverable itself. Ideally all links inside the below table should include a commit hash, which should be used for | ||
testing. | ||
|
||
| Number | Deliverable | Link | Notes | | ||
|--------|-----------------|-------------------------------------------------------------------------------|-----------------------| | ||
| 0a. | License | https://github.com/gmajor-encrypt/php-substrate-api | MIT license | | ||
| 0b.1 | Documentation 1 | https://github.com/gmajor-encrypt/php-substrate-api#rpc | Signed Extrinsic send | | ||
| 0b.2 | Documentation 2 | https://github.com/gmajor-encrypt/php-scale-codec#extrinsic | Extrinsic encode | | ||
| 1. | Source code 1 | https://github.com/gmajor-encrypt/php-scale-codec | Codec | | ||
| 2. | Source code 2 | https://github.com/gmajor-encrypt/php-substrate-api | RPC Lib | | ||
| 3. | Unit Tests 1 | https://github.com/gmajor-encrypt/php-substrate-api/tree/master/test/Rpc | make test | | ||
| 4. | Unit Tests 2 | https://github.com/gmajor-encrypt/php-scale-codec/tree/master/test/Codec/Test | make test | | ||
| 5. | Packagist | https://packagist.org/packages/gmajor/php-substrate-api | Packagist | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Evaluation | ||
|
||
- **Status:** Accepted | ||
- **Application Document:** https://github.com/w3f/Grants-Program/tree/master/applications/SubIdentity.md | ||
- **Milestone:** 1 | ||
- **Kusama Identity:** Fa73LcKf9BMHUp9k6wv7LiHu2jd65UhWPn7JSRUPpt2XgAQ | ||
- **Previously successfully merged evaluation:** N/A | ||
|
||
| Number | Deliverable | Accepted | Link | Evaluation Notes | | ||
| ------ | ----------- | -------- | ---- |----------------- | | ||
| 0a. | License | <ul><li>[x] </li><ul> | [subidentity-webapp](https://github.com/TDSoftware/subidentity-webapp/blob/4f1c3c6855ce76d2bc43f3aa17bb60b02798686a/LICENSE), [subidentitiy-package](https://github.com/TDSoftware/subidentity-package/blob/0169bddeac12de534b126198d6818feac8939da3/LICENSE) | Apache 2.0 for both repositeries| | ||
| 0b. | Documentation | <ul><li>[x] </li><ul> | [subidentity-webapp](https://github.com/TDSoftware/subidentity-webapp/blob/4f1c3c6855ce76d2bc43f3aa17bb60b02798686a/README.md), [subidentity-package](https://github.com/TDSoftware/subidentity-package/blob/0169bddeac12de534b126198d6818feac8939da3/README.md), [tutorial](https://github.com/TDSoftware/subidentity-webapp/blob/4f1c3c6855ce76d2bc43f3aa17bb60b02798686a/docs/Tutorial.md) | Basic documentation on installing, running and testing the application are shown in the README and are working as expected. In addition, there is also reasonable inline documentation of code. The website itself is simple enough that the tutorial isn't needed at this stage except for giving an overview of functionality. | | ||
| 0c. | Testing | <ul><li>[x] </li><ul> | | All components with logic are tested in `subidentity-webapp`. `subidentity-package` is also adequately unit tested but could use more coverage for unexpected inputs (see general notes below). | | ||
| 1. | Concept and design | <ul><li>[x] </li><ul> | | Intuitive design and good responsiveness overall for the search, list view and detailed identity view. | | ||
| 2. | Implement logic for querying identities | <ul><li>[x] </li><ul> | [subidentity-package](https://github.com/TDSoftware/subidentity-package/tree/0169bddeac12de534b126198d6818feac8939da3) | Works correctly for normal inputs | | ||
| 3. | Implement UI for search and list view | <ul><li>[x] </li><ul> | [subidentity-webapp](https://github.com/TDSoftware/subidentity-webapp/tree/4f1c3c6855ce76d2bc43f3aa17bb60b02798686a) | Overall UI design is intuitive, with some minor hiccups (see general notes). | | ||
| 4. | Implement UI for detailed identity view| <ul><li>[x] </li><ul> | [subidentity-webapp](https://github.com/TDSoftware/subidentity-webapp/tree/4f1c3c6855ce76d2bc43f3aa17bb60b02798686a) | See above. In addition, custom plugins can provide additional functionality as outlined in the README. | | ||
|
||
|
||
## General Notes | ||
|
||
|
||
Overall the deliverables are adequately met. The UI is responsive and intuitive, and works well in both desktop and mobile resolutions. | ||
|
||
|
||
Additional feedback: | ||
|
||
* Search strings with more search results are slower to appear which may become problematic as more on-chain identities are registered. | ||
* Some (unexpected?) search strings e.g. "*" cause errors in the console and the spinner to spin continously, giving the impression that the website is hanging. | ||
* The detailed identity view could perhaps use the space a bit better for desktop resolutions, and it would be nice to have additional data such as registrar information for judgements included with the default `BasicInfoPlugin.vue`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Evaluation | ||
|
||
- **Status:** Accepted | ||
- **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/asylum.md | ||
- **Milestone:** 1 | ||
- **Kusama Identity:** [ESxS4A7GHMLzve4Mbc9t27RpXtVTnV3LtcMTtcnD26jcUHA](https://polkascan.io/pre/kusama/account/ESxS4A7GHMLzve4Mbc9t27RpXtVTnV3LtcMTtcnD26jcUHA) | ||
- **Previously successfully merged evaluation:** All by semuelle | ||
|
||
| Number | Deliverable | Accepted | Link | Evaluation Notes | | ||
| ------ | ----------- | :------: | ---- |----------------- | | ||
| 0a. | License | <ul><li>[x] </li></ul> | [asylum-space/asylum-ui](https://gitlab.com/asylum-space/asylum-ui/-/blob/345efe949f615f5e300b6aa1614f8b0fa5807e33/LICENSE), [asylum-space/asylum-item-nft](https://gitlab.com/asylum-space/asylum-item-nft/-/blob/2e703840b79527ad1cf29feddb26ad980b030b09/LICENSE) | MIT | | ||
| 0b. | Documentation | <ul><li>[x] </li></ul> | [asylum-space/asylum-item-nft](https://gitlab.com/asylum-space/asylum-item-nft/-/blob/2e703840b79527ad1cf29feddb26ad980b030b09/pallets/asylum-core/README.md), [asylum-space/asylum-standards](https://gitlab.com/asylum-space/asylum-standards/-/tree/f3024ff05656634cd9fa9cdaa0e7dca35c8cb320/standards/asylum0.1) | — | | ||
| 0c. | Testing Guide | <ul><li>[x] </li></ul> | [asylum-space/asylum-item-nft](https://gitlab.com/asylum-space/asylum-item-nft/-/blob/2e703840b79527ad1cf29feddb26ad980b030b09/docs/testing-guide.md), [packages/connection-library](https://gitlab.com/asylum-space/asylum-ui/-/blob/345efe949f615f5e300b6aa1614f8b0fa5807e33/packages/connection-library/docs/testing-guide.md), [packages/game-developers-console](https://gitlab.com/asylum-space/asylum-ui/-/blob/345efe949f615f5e300b6aa1614f8b0fa5807e33/packages/game-developers-console/docs/testing-guide.md) | Good test coverage. Updated on request. | | ||
| 0d. | Docker | <ul><li>[x] </li></ul> | [asylum-space/asylum-ui](https://gitlab.com/asylum-space/asylum-ui/-/blob/e9bd2e98a6702543434e7083ae34eeec9acfd01e/docker-compose.yaml) | Provided on request. | | ||
| 1. | Item standard definition | <ul><li>[x] </li></ul> | [asylum-space/asylum-standards](https://gitlab.com/asylum-space/asylum-standards/-/blob/f3024ff05656634cd9fa9cdaa0e7dca35c8cb320/standards/asylum0.1/README.md) | Good documentation all around. | | ||
| 1.1 | 2D visualization | <ul><li>[x] </li></ul> | [asylum-space/asylum-item-nft](https://gitlab.com/asylum-space/asylum-item-nft/blob/fe41b6f2c4b85efb751d1db6b711793fa64cf60e/pallets/asylum-core/src/functions.rs#L42) | — | | ||
| 1.2 | 3D visualization | <ul><li>[x] </li></ul> | [asylum-space/asylum-item-nft](https://gitlab.com/asylum-space/asylum-item-nft/blob/fe41b6f2c4b85efb751d1db6b711793fa64cf60e/pallets/asylum-core/src/functions.rs#L42) | — | | ||
| 1.3 | Multiple visual interpretations | <ul><li>[x] </li></ul> | [testing-guide.md](https://gitlab.com/asylum-space/asylum-ui/-/blob/4fff99c2054b4dfd7b926e9cd432f678fb4bffd7/packages/game-developers-console/docs/testing-guide.md#step-3-configure-template-and-interpretations) | — | | ||
| 2. | Asylum Core pallet | <ul><li>[x] </li></ul> | [asylum-space/asylum-item-nft](https://gitlab.com/asylum-space/asylum-item-nft/-/tree/8877af0bafa9f977702e529e85c455a602912587/pallets/asylum-core) | — | | ||
| 3. | Connection library | <ul><li>[x] </li></ul> | [asylum-space/asylum-ui](https://gitlab.com/asylum-space/asylum-ui/-/tree/cba551d1b7a44e4951816692bf090e136aea8817/packages/connection-library) | — | | ||
| 4. | Web application | <ul><li>[ ] </li></ul> | [asylum-space/asylum-ui](https://gitlab.com/asylum-space/asylum-ui/-/tree/cba551d1b7a44e4951816692bf090e136aea8817/packages/game-developers-console) | No minting, will be part of M2. | | ||
|
||
|
||
## General Notes | ||
|
||
Very slick UI & UX. Good test coverage. |
Oops, something went wrong.