Skip to content

Commit

Permalink
Merge branch 'w3f:master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
meanking authored Nov 14, 2023
2 parents 4263216 + 3c57355 commit 29ccc06
Show file tree
Hide file tree
Showing 28 changed files with 1,906 additions and 139 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

- [x] The [application template](https://github.com/w3f/Grants-Program/blob/master/applications/application-template.md) has been copied and aptly renamed (`project_name.md`).
- [ ] I have read the [application guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/grant_guidelines_per_category.md).
- [ ] Payment details have been provided (bank details via email _or_ Polkadot (USDC & USDT) or BTC address in the application).
- [ ] Payment details have been provided (bank details via email _or_ Polkadot (USDC & USDT) address in the application).
- [ ] The software delivered for this grant will be released under an open-source license specified in the application.
- [ ] The initial PR contains only one commit (squash and force-push if needed).
- [ ] The grant will only be announced once the first milestone [has been accepted](https://github.com/w3f/Grant-Milestone-Delivery#process) (see the [announcement guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/announcement-guidelines.md)).
Expand Down
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,9 @@ In cases where a niche expert opinion is desirable, one of the committee members
- [Aeron Buchanan](https://github.com/aeronbuchanan)
- [Gautam Dhameja](https://github.com/gautamdhameja)
- [David Hawig](https://github.com/Noc2)
- [Diogo Mendonça](https://github.com/dsm-w3f)
- [Sebastian Müller](https://github.com/semuelle)
- [Bill Laboon](https://github.com/laboon)
- [Keegan Quigley](https://github.com/keeganquigley)
- [Nikhil Ranjan](https://github.com/nikw3f)
- [Raul Romanutti](https://github.com/rrtti)
- [Seraya Takahashi](https://github.com/takahser)
- [Benjamin Weiß](https://github.com/BenWhiteJam)
Expand All @@ -105,18 +103,15 @@ In cases where a niche expert opinion is desirable, one of the committee members
Evaluators are individuals able to evaluate the technology delivered as a result of the Grants Program. The committee has the right to add or remove evaluators on the basis of supermajority.

- [David Hawig](https://github.com/Noc2)
- [Diogo Mendonça](https://github.com/dsm-w3f)
- [Sebastian Müller](https://github.com/semuelle)
- [Keegan Quigley](https://github.com/keeganquigley)
- [Nikhil Ranjan](https://github.com/nikw3f)
- [Seraya Takahashi](https://github.com/takahser)

#### W3F Operations Team<!-- omit in toc -->

The Operations Team takes care of legal documents, invoicing, and remittances.

- [Melanie Diener](https://github.com/meldien)
- [Federica Dubbini](https://github.com/fededubbi)
- [Rouven Pérez](https://github.com/RouvenP)


Expand Down Expand Up @@ -147,7 +142,7 @@ The W3F Grants Program offers different grant levels to help you best, depending

## :pencil: Process

> **:loudspeaker:** Payments can be made in USDT and USDC on the Polkadot [AssetHub](https://wiki.polkadot.network/docs/learn-assets), Bitcoin, and fiat (USD, EUR, CHF). Please indicate your preference in the application [as outlined in our application template](https://github.com/w3f/Grants-Program/blob/master/applications/application-template.md?plain=1#L7). If you want to apply in **private**, you can do so [:arrow_right: here](https://docs.google.com/forms/d/e/1FAIpQLSfMfjiRmDQDRk-4OhNASM6BAKii7rz_B1jWtbCPkUh6N7M2ww/viewform). Note that this is generally a slower process and imposes stricter requirements on applicants.
> **:loudspeaker:** Payments can be made in USDT and USDC on the Polkadot [AssetHub](https://wiki.polkadot.network/docs/learn-assets) and fiat (USD, EUR, CHF). Please indicate your preference in the application [as outlined in our application template](https://github.com/w3f/Grants-Program/blob/master/applications/application-template.md?plain=1#L7). If you want to apply in **private**, you can do so [:arrow_right: here](https://docs.google.com/forms/d/e/1FAIpQLSfMfjiRmDQDRk-4OhNASM6BAKii7rz_B1jWtbCPkUh6N7M2ww/viewform). Note that this is generally a slower process and imposes stricter requirements on applicants.
### 1. Application

Expand Down Expand Up @@ -222,7 +217,7 @@ Please note that:

We give away 500 USD to each referral of a successful grant application by _anyone having previously worked on a Web3 Foundation grant_ or _a [Polkadot Ambassador](https://wiki.polkadot.network/docs/ambassadors)_. Web3 Foundation and Parity employees do not qualify for the program, even if they previously worked on a grant.

In order to be eligible for the referral bonus, the application itself must contain the name of the [Polkadot Ambassador](https://wiki.polkadot.network/docs/ambassadors) or the GitHub account of the grantee as well as the payment address for the referral bonus (see the [application template](applications/application-template.md)). Payment is made in Bitcoin or USDT/USDC on Polkadot AssetHub after delivery and approval of the first milestone.
In order to be eligible for the referral bonus, the application itself must contain the name of the [Polkadot Ambassador](https://wiki.polkadot.network/docs/ambassadors) or the GitHub account of the grantee as well as the payment address for the referral bonus (see the [application template](applications/application-template.md)). Payment is made in USDT/USDC on Polkadot AssetHub after delivery and approval of the first milestone.

## :bulb: Help

Expand Down
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
1 change: 1 addition & 0 deletions applications/Claps.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
- **Team Name:** Taiwan Research-based Biopharmaceutical Manufacturers Association
- **Payment Address:** 0x39D3E0c7AAcfbCa133f08cfb153B4888fd36bA9B (DAI)
- **[Level](https://github.com/w3f/Grants-Program/tree/master#level_slider-levels):** 2
- **Status:** [Terminated](https://github.com/w3f/Grants-Program/pull/1440#issuecomment-1773610786)

## Overview

Expand Down
Loading

0 comments on commit 29ccc06

Please sign in to comment.