A publicly-accessible, source-decentralized indexer that harvests metadata directly from Apps' websites and publishes them here as a centralized JSON registry where wallets can discover apps operating on specific blockchains.
This repository is configured with GitHub actions to automatically fetch metadata from Apps' websites and update the global.json file multiple times per day.
In order to register an App, all you have to do is open a PR to add an empty .url file under sources/ that references the website by its hostname. That's it! Anyone can register an app.
For example, an empty file called app.example.net.url will trigger the indexer to make a request to https://app.example.net/.
In most cases, Websites will already be compatible with most of the following requirements except for the WHIP-003 blockchain declarations should be very straightforward to add. See example below.
- App name and app icon via any of the following means (ordered by descending precedence):
- Implement the WHIP-002 specification (recommended)
- OR embed a valid Web app manifest that includes the
short_nameproperty and an SVG image entry undericons
- Identify which blockchain(s) it operates on via the WHIP-003 specification
- App description via any of the following means (ordered by descending precedence):
- Use the
<meta name="description" ...>element (recommended) - OR use the
<meta name="og:description" ...>element from the Open Graph protocol - OR embed a valid Web app manifest that includes the
descriptionproperty
- Use the
- be using HTTPS offering TLS 1.2 or TLS 1.3 and serving a valid certificate
- in response to
GET /, return an HTTP response with a 2xx status code OR 3xx redirect to a path on the same origin - include the
Content-TypeHTTP header with a value oftext/htmland contain a valid HTML document in the response body
This indexer will consider an App to be compatible with mobile devices if the Website:
- includes a
<meta name="viewport" ...>element
This indexer will automatically pull the latest metadata from your website every few hours, giving you full control of your own metadata. This is what 'source-decentralized' means. Registering with this repository is set-and-forget!
If your website updates and no longer meets the requirements, it will be removed from the published JSON. As soon as it meets the requirements again, it will automatically be re-added to the published JSON again.
Let's say someone wants to add app.example.net to the registry.
A GET request to https://app.example.net/ should return something like the following:
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Example App: Homepage</title>
<!-- basic App metadata -->
<meta name="application-name" content="Example App">
<meta name="description" content="All your base are belong to us">
<link rel="icon" type="image/svg+xml" href="/logo.svg">
<!-- which blockchain(s) are supported -->
<script type="application/toml" data-whip-003>
[chains.secret-network]
namespace = "cosmos"
reference = "secret-4"
[chains.ethereum]
namespace = "eip155"
reference = "1"
</script>
<!-- App is compatible with mobile devices -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<h1>Hello world</h1>
</body>
</html>Create a new file in this repository under the sources/ directory (replacing app.example.net.url filename with the appropriate URL for your app if you used the link). The contents of the file MUST remain empty.
Finally, submit a PR to this repository adding the file. It will be reviewed
The latest published JSON registry is available at the persistent URL:
https://raw.githubusercontent.com/SolarRepublic/wallet-apps-registry/main/global.jsonThe schema of this file is described in the following typings:
type AppEntry = {
name: string;
description: string;
icon: `https://raw.githubusercontent.com/SolarRepublic/wallet-apps-registry/main/cache/${string}.svg`;
};
type WalletAppsRegistryJson = Array<AppEntry>;