Skip to content

Commit

Permalink
Merge pull request #1 from klayrHQ/rebranding-to-klayr
Browse files Browse the repository at this point in the history
Rebranding to Klayr app registry
  • Loading branch information
corbifex authored May 20, 2024
2 parents 6f3e9fd + 3d6307e commit 5492f68
Show file tree
Hide file tree
Showing 64 changed files with 750 additions and 720 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/pr-validation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
id: checkUserMember
with:
username: ${{ github.actor }}
organization: 'LiskHQ'
organization: 'KlayrHQ'
team: 'platform'
GITHUB_TOKEN: ${{ secrets.READ_ACCESS_TOKEN }}
- name: Set TEAM_MEMBER_STATUS to false if READ_ACCESS_TOKEN is not present
Expand Down
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
![Logo](./docs/assets/banner_app_registry.png)
# Klayr Application Registry

# Lisk Application Registry

Welcome to the Lisk Application Registry. The repository contains off-chain metadata for applications developed based on the Lisk SDK and any other applications that are compatible with the Lisk Protocol.
Welcome to the Klayr Application Registry. The repository contains off-chain metadata for applications developed based on the Klayr SDK and any other applications that are compatible with the Klayr Protocol.
Each application will include the [*app.json*](#app-json) containing the blockchain application-specific metadata and [*nativetokens.json*](#native-tokens-json) containing metadata about the application's native tokens.

## Repository Structure

The blockchain application metadata is arranged in the following structure: <br/> `{network}/{application}`, such as *mainnet/Lisk*.
The blockchain application metadata is arranged in the following structure: <br/> `{network}/{application}`, such as *mainnet/Klayr*.

The repository currently supports adding off-chain application metadata for the following networks:
- mainnet
Expand All @@ -16,15 +14,15 @@ The repository currently supports adding off-chain application metadata for the

### App JSON

*app.json* contains high-level metadata about a specific blockchain application, such as the `chainName` corresponding to an existing `chainID`. It also supplies information regarding the application's genesis block (`genesisURL`), seed nodes (`appNodes`), corresponding Lisk Service deployments (`serviceURLs`), explorers and more. This information makes it easy to bootstrap a new node in the network or interact with an existing node.
*app.json* contains high-level metadata about a specific blockchain application, such as the `chainName` corresponding to an existing `chainID`. It also supplies information regarding the application's genesis block (`genesisURL`), seed nodes (`appNodes`), corresponding Klayr Service deployments (`serviceURLs`), explorers and more. This information makes it easy to bootstrap a new node in the network or interact with an existing node.

All the *app.json* files within the repository must adhere to the schema specified [here](./schema/app.json).

Example: *mainnet/Lisk/app.json*
Example: *mainnet/Klayr/app.json*

*Important information*:
- All the specified URLs in *app.json* (i.e. `genesisURL`, `appNodes`, and `serviceURLs`, etc.) are validated in real-time. Hence, please ensure that they are valid and reachable at the time of submission.
- Prior to the metadata submission, please ensure that the Lisk applications are registered on the Lisk mainchain and vice-versa.
- Prior to the metadata submission, please ensure that the Klayr applications are registered on the Klayr mainchain and vice-versa.
- For logos pointing to app-registry GitHub URL, use the main branch in the URL to ensure working functionality after PR merge. All logos submitted need to adhere to `64px x 64px` resolution.
- For `mainnet` and `testnet` submissions, it is necessary that all the API deployments are secured with SSL/TLS.
- For every SSL/TLS secured API deployment (i.e. for `appNodes`, and `serviceURLs`), it is mandatory to specify the `apiCertificatePublicKey`.
Expand All @@ -36,14 +34,14 @@ Example: *mainnet/Lisk/app.json*

### Native Tokens JSON

*nativetokens.json* contains metadata about the blockchain application's native tokens, which enables token discoverability across the Lisk ecosystem and for community tools.
*nativetokens.json* contains metadata about the blockchain application's native tokens, which enables token discoverability across the Klayr ecosystem and for community tools.

All the *nativetokens.json* files within the repository must adhere to the schema specified [here](./schema/nativetokens.json).

Example: *mainnet/Lisk/nativetokens.json*
Example: *mainnet/Klayr/nativetokens.json*

*Important information*:
- Prior to the metadata submission, please ensure that the Lisk applications are registered on the Lisk mainchain and vice-versa.
- Prior to the metadata submission, please ensure that the Klayr applications are registered on the Klayr mainchain and vice-versa.
- For logos pointing to app-registry GitHub URL, use the main branch in the URL to ensure working functionality after PR merge. All logos submitted need to adhere to `64px x 64px` resolution.

### Logo Images
Expand All @@ -52,7 +50,7 @@ We recommend that all the *svg* and *png* format logo images added to the reposi

We also recommend that all the images are stored directly under the application's directory in the `images` subdirectory.

Example: *mainnet/Lisk/images/application/lisk.svg*
Example: *mainnet/Klayr/images/application/klayr.svg*

## Contributing
To contribute to the application registry with the metadata for your blockchain application, please [fork this repository and submit a *Pull Request*](./docs/creating-pull-request-from-a-fork.md) with the necessary changes. Before submitting a PR, please read through the [Repository Structure](#repository-structure) section.
Expand All @@ -61,10 +59,11 @@ This app-registry was inspired by [Cosmos Chain Registry](https://github.com/cos

## Contributors

https://github.com/LiskHQ/app-registry/graphs/contributors
https://github.com/KlayrHQ/app-registry/graphs/contributors

## License

Copyright 2024 Klayr Holding B.V.
Copyright 2016-2024 Lisk Foundation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Expand Down
28 changes: 28 additions & 0 deletions devnet/Klayr/app.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"title": "Klayr - Devnet",
"description": "Metadata configuration for the Klayr blockchain (mainchain) in devnet",
"chainName": "klayr_mainchain",
"displayName": "Klayr",
"chainID": "04000000",
"networkType": "devnet",
"genesisURL": "https://github.com/KlayrHQ/klayr-core/blob/development/config/devnet/genesis_assets.json",
"projectPage": "https://klayr.xyz",
"logo": {
"png": "https://downloads.klayr.xyz/media/klayr.png",
"svg": "https://downloads.klayr.xyz/media/klayr.svg"
},
"backgroundColor": "#EDEDCE",
"serviceURLs": [
{
"http": "http://127.0.0.1:9901",
"ws": "ws://127.0.0.1:9901"
}
],
"explorers": [],
"appNodes": [
{
"url": "ws://127.0.0.1:7887",
"maintainer": "Klayr Labs B.V."
}
]
}
Binary file added devnet/Klayr/images/application/klayr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions devnet/Klayr/images/application/klayr.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added devnet/Klayr/images/tokens/klayr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions devnet/Klayr/images/tokens/klayr.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 9 additions & 9 deletions devnet/Lisk/nativetokens.json → devnet/Klayr/nativetokens.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"title": "Lisk - Devnet - Native tokens",
"title": "Klayr - Devnet - Native tokens",
"tokens": [
{
"tokenID": "0400000000000000",
"tokenName": "Lisk",
"description": "Default token for the entire Lisk ecosystem",
"tokenName": "Klayr",
"description": "Default token for the entire Klayr ecosystem",
"denomUnits": [
{
"denom": "beddows",
Expand All @@ -14,19 +14,19 @@
]
},
{
"denom": "lsk",
"denom": "kly",
"decimals": 8,
"aliases": [
"Lisk"
"Klayr"
]
}
],
"baseDenom": "beddows",
"displayDenom": "lsk",
"symbol": "LSK",
"displayDenom": "kly",
"symbol": "KLY",
"logo": {
"png": "https://raw.githubusercontent.com/LiskHQ/app-registry/main/devnet/Lisk/images/tokens/lisk.png",
"svg": "https://raw.githubusercontent.com/LiskHQ/app-registry/main/devnet/Lisk/images/tokens/lisk.svg"
"png": "https://downloads.klayr.xyz/media/klayr.png",
"svg": "https://downloads.klayr.xyz/media/klayr.svg"
}
}
]
Expand Down
28 changes: 0 additions & 28 deletions devnet/Lisk/app.json

This file was deleted.

Binary file removed devnet/Lisk/images/application/lisk.png
Binary file not shown.
12 changes: 0 additions & 12 deletions devnet/Lisk/images/application/lisk.svg

This file was deleted.

Binary file removed devnet/Lisk/images/tokens/lisk.png
Binary file not shown.
12 changes: 0 additions & 12 deletions devnet/Lisk/images/tokens/lisk.svg

This file was deleted.

4 changes: 2 additions & 2 deletions docs/creating-pull-request-from-a-fork.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
3. On the next page, click on the **compare across forks** link.
![Compare across forks](./assets/contributing/compare-across-forks-link.webp)

4. Next, set "base repository" to `LiskHQ/app-registry` and `base` to `main`.
4. Next, set "base repository" to `klayrhq/app-registry` and `base` to `main`.
![Choose base fork and branch](./assets/contributing/choose-base-fork-and-branch.png)

5. Next, select your own repository as the `head repository` from the drop-down and set `compare` to the branch containing your changes.
Expand All @@ -20,4 +20,4 @@

8. To create a pull request that is ready for review, click **Create Pull Request**. To create a draft pull request, use the drop-down and select **Create Draft Pull Request**, then click **Draft Pull Request**.

> **Note:** Please make sure to validate your PR to ensure that all GitHub Actions checks are passing. This will help ensure that your changes meet the project's quality standards and do not introduce any errors or issues.
> **Note:** Please make sure to validate your PR to ensure that all GitHub Actions checks are passing. This will help ensure that your changes meet the project's quality standards and do not introduce any errors or issues.
40 changes: 40 additions & 0 deletions mainnet/Klayr/app.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"title": "Klayr - Mainnet",
"description": "Metadata configuration for the Klayr blockchain (mainchain) in mainnet",
"chainName": "klayr_mainchain",
"displayName": "Klayr",
"chainID": "00000000",
"networkType": "mainnet",
"genesisURL": "https://github.com/KlayrHQ/klayr-core/blob/development/config/mainnet/genesis_assets.json",
"projectPage": "https://klayr.xyz",
"logo": {
"png": "https://downloads.klayr.xyz/media/klayr.png",
"svg": "https://downloads.klayr.xyz/media/klayr.svg"
},
"backgroundColor": "#EDEDCE",
"serviceURLs": [
{
"http": "https://service.klayr.xyz",
"ws": "wss://service.klayr.xyz",
"apiCertificatePublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoWCLObWsqufJm3aOSigy\nvc+kpjE2058UtgBgNfqp7nfcHePMzSpLZrLiILN8m5y0E4UYT4ywLSe7nzzbmLEW\n+BTSItaAPP/cOLPA89VhbmEDQJa2ndfGT5CGP++duvlQ6yH0JHdOkwIpr+o7Mjvs\nSfgIMtALtm5uNOGN4sJSFoNPjXDpskgHi6rOXXifN89wXx38KNCll+tlzUFjOtLR\nZI8ykq+5TDtS9NBJKqIHS3xIQXpXHK63mA9ogmmMwN/4cPh8S+vVUigzdorH6+4m\nFSdE+KfZHc+eK5mr+FfCRJOo6PKMCEeAM1ykBvyX93PwqCndeM+ldL2/EfQvijN+\n+wIDAQAB\n-----END PUBLIC KEY-----"
}
],
"explorers": [
{
"url": "https://explorer.klayr.xyz",
"txnPage": "https://explorer.klayr.xyz/transactions"
}
],
"appNodes": [
{
"url": "https://mainnet.klayr.xyz",
"maintainer": "Klayr Labs B.V.",
"apiCertificatePublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoWCLObWsqufJm3aOSigy\nvc+kpjE2058UtgBgNfqp7nfcHePMzSpLZrLiILN8m5y0E4UYT4ywLSe7nzzbmLEW\n+BTSItaAPP/cOLPA89VhbmEDQJa2ndfGT5CGP++duvlQ6yH0JHdOkwIpr+o7Mjvs\nSfgIMtALtm5uNOGN4sJSFoNPjXDpskgHi6rOXXifN89wXx38KNCll+tlzUFjOtLR\nZI8ykq+5TDtS9NBJKqIHS3xIQXpXHK63mA9ogmmMwN/4cPh8S+vVUigzdorH6+4m\nFSdE+KfZHc+eK5mr+FfCRJOo6PKMCEeAM1ykBvyX93PwqCndeM+ldL2/EfQvijN+\n+wIDAQAB\n-----END PUBLIC KEY-----"
},
{
"url": "wss://mainnet.klayr.xyz",
"maintainer": "Klayr Labs B.V.",
"apiCertificatePublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoWCLObWsqufJm3aOSigy\nvc+kpjE2058UtgBgNfqp7nfcHePMzSpLZrLiILN8m5y0E4UYT4ywLSe7nzzbmLEW\n+BTSItaAPP/cOLPA89VhbmEDQJa2ndfGT5CGP++duvlQ6yH0JHdOkwIpr+o7Mjvs\nSfgIMtALtm5uNOGN4sJSFoNPjXDpskgHi6rOXXifN89wXx38KNCll+tlzUFjOtLR\nZI8ykq+5TDtS9NBJKqIHS3xIQXpXHK63mA9ogmmMwN/4cPh8S+vVUigzdorH6+4m\nFSdE+KfZHc+eK5mr+FfCRJOo6PKMCEeAM1ykBvyX93PwqCndeM+ldL2/EfQvijN+\n+wIDAQAB\n-----END PUBLIC KEY-----"
}
]
}
Binary file added mainnet/Klayr/images/application/klayr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions mainnet/Klayr/images/application/klayr.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added mainnet/Klayr/images/tokens/klayr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5492f68

Please sign in to comment.