Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Amend Calamar's milestone 3 #2055

Merged
merged 1 commit into from
Oct 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 23 additions & 14 deletions applications/Calamar.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,26 +69,31 @@ As we are gathering feedback, one of the most important features for the users s
- account's name if set
- owned assets accross all listed chains, including dollar values and graphs for visualization.
- list all chain-specific addresses
- list all related transfers, XCM transfers, extrinsics and calls
- list all related transfers, extrinsics and calls

![Account page](https://res.cloudinary.com/topmonks/image/upload/v1672668761/calamar/account2.png)
![Account page](https://res.cloudinary.com/topmonks/image/upload/v1672668761/calamar/account3.png)

#### Chain dashboards

Each chain will have own dashboard with statistics and listing of latest blocks, latest transfers, top holders, etc. It makes the explorer more useful even for users who are not searching for specific items.

![Statistics page](https://res.cloudinary.com/topmonks/image/upload/v1661765199/calamar/statistics.png)
![Statistics page](https://res.cloudinary.com/topmonks/image/upload/v1697542484/calamar/statistics2.png)

#### Cross-chain transfers
Important feature is to create good UI for displaying information about XCM teleports and other cross-chain transfers where you can easily see all involved sides (chains, accounts) and other useful data.
#### Metadata explorer

- XCM transfer detail
The runtime metadata of each chain are still evolving and changing but it is not so easy to display them in a structured and human-readable way. There is e.g. a tool https://wiki.polkadot.network/docs/metadata which displays them but only latest version and supports only a few networks. The metadata explorer we are going to implement will support all the networks and also historical versions of the runtime spec.

![XCM transfer page](https://res.cloudinary.com/topmonks/image/upload/v1662492906/calamar/xcm-transfer-detail.png)
![Metadata explorer](https://res.cloudinary.com/topmonks/image/upload/v1672668761/calamar/metadata_explorer.png)

- in transfers table
#### Item metadata

![Transfers table](https://res.cloudinary.com/topmonks/image/upload/v1662492938/calamar/xcm-transfers-list.png)
The metadata information will be deeply integrated into whole Calamar so we can display it in the detail pages of the items. E.g. in extrinsic's detail page we will show info for the call name, error, parameters and link to the metadata explorer for more info.

![Extrinsic metadata](https://res.cloudinary.com/topmonks/image/upload/v1672668761/calamar/extrinsic_metadata.png)

#### Search input autocomplete for call and event names

Thanks to the metadata we can also autocomplete and suggest the call and event names when typing into the search input.

### Technology stack

Expand Down Expand Up @@ -203,7 +208,7 @@ Even though we have the already working application, there are still many things
| 10. | Website polishing | Add useful information to the website (footer with team logos, contact information, terms, etc.). |
| 11. | Polkadot.js integration | Create a PR to integrate links to the Calamar Explorer into Polkadot.js app. |

### Milestone 2 - Account detail & Cross-chain transfers
### Milestone 2 - Account detail & Chain dashboards

- **Estimated duration:** 4 weeks
- **FTE:** 1
Expand Down Expand Up @@ -232,10 +237,10 @@ In this milestone we are going to improve [account detail](#account-detail) page
| 10. | Chain dashboard / Top holders | Add top holders list table |


### Milestone 3 - Universal search & Chain dashboards
### Milestone 3 - Universal search & Metadata explorer

- **Estimated duration:** 3 weeks
- **FTE:** 1
- **Estimated duration:** 8 weeks
- **FTE:** 0.375
- **Costs:** $7,500

In this milestone we are going to implement [universal search](#universal-search) and one of the most requested features: [cross-chain transfers](#cross-chain-transfers) detection.
Expand All @@ -248,12 +253,16 @@ In this milestone we are going to implement [universal search](#universal-search
| 0d. | Docker | *N/A - will be provided by the first milestone.* |
| 0e. | Article | We will publish an article that explains what was done as part of the grant |
| 1. | Universal search | Search items through all the chains without the knowledge where it belongs. See [Universal search](#universal-search). |
| 2. | XCM transfers and teleports | Detect cross-chain transfers and display relevant information of involved chains and accounts: from chain, to chain, relayed at chain (reserve), sender, beneficiary, etc. Also add their listings to account detail and chain dashboard. See [Cross-chain transfers](#cross-chain-transfers) for more. |
| 2. | Metadata explorer | UI interface for exploring metadata retrieved from network's latest and historical versions of runtime spec. See [Metadata explorer](#metadata-explorer).
| 3. | Show related runtime metadata in items' detail | Show related metadata information directly in detail pages of individual items and interlink to metadata explorer. See [Item metadata](#item-metadata).
| 4. | Search input autocomplete | Autocomplete extrinsic and event name in the search input. See [Search input autocomplete for call and event names](#search-input-autocomplete-for-call-and-event-names).

## Future Plans

There is a huge potential for future improvements which the Polkadot's community can benefit from.

We would like to definitely display information about XCM transfers and teleports.

As developers of most parachains implement their own custom modules/pallets it opens the opportunity to cooperate and customize Calamar explorer with UI/UX components and logic tailored to their needs.

It relates to various XCM transactions which makes it even more complex and the more types will our explorer support the more it makes the users' lives easier.
Expand Down
Loading