Skip to content

Commit

Permalink
Merge branch 'chainapsis:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
chaitanyaprabhu10 authored Aug 2, 2024
2 parents 047cdb2 + dd2089a commit a3634c5
Show file tree
Hide file tree
Showing 402 changed files with 5,455 additions and 1,112 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/cron-job.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ jobs:
continue-on-error: true
run: |
yarn ts-node src/schedule.ts
env:
PRICE_URL: ${{ secrets.PRICE_URL }}

- name: Slack Alert Notification
uses: slackapi/[email protected]
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- name: Setup node
uses: actions/setup-node@v3
with:
node-version: '18'
node-version: "18"
registry-url: "https://registry.npmjs.org"
- run: npm install --global yarn
- name: Get yarn cache directory path
Expand Down Expand Up @@ -51,8 +51,8 @@ jobs:
AWS_REGION: us-west-2
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
- run: yarn ts-node src/cms.ts
env:
WEBFLOW_TOKEN: ${{ secrets.WEBFLOW_TOKEN }}
WEBFLOW_COLLECTION_ID: ${{ secrets.WEBFLOW_COLLECTION_ID }}

# Disable temporarily
# - run: yarn ts-node src/cms.ts
# env:
# WEBFLOW_TOKEN: ${{ secrets.WEBFLOW_TOKEN }}
# WEBFLOW_COLLECTION_ID: ${{ secrets.WEBFLOW_COLLECTION_ID }}
1 change: 1 addition & 0 deletions .github/workflows/pull-request-validation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ jobs:
with:
files: |
cosmos/**
evm/**
- name: Validate changed files
run: |
Expand Down
1 change: 1 addition & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
module.exports = {
trailingComma: "all",
tabWidth: 2,
endOfLine: "auto",
};
156 changes: 125 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
> **Warning**
>
>
> PLEASE RUN THE COMMANDS BELOW TO VERIFY CONFIGURATION IN YOUR LOCAL ENVIRONMENT BEFORE SUBMITTING PULL REQUESTS.
>
> ```shell
> # install node modules
> yarn install
>
> # validate your json file (ex. yarn validate cosmos/osmosis.json)
>
> # validate your json file (for Cosmos-SDK-based chains or EVM chains)
> yarn validate cosmos/{your file.json}
> yarn validate evm/{your file.json}
> ```
>
>
> READ THE GUIDELINES BELLOW CAREFULLY, PAYING PARTICULAR ATTENTION TO THE "features" IN THE [[REQUIREMENT DETAILS](https://github.com/chainapsis/keplr-chain-registry#requirement-details)].
# Guidelines for Community-Driven Non-Native Chain Integration
Keplr team has always been at the leading edge of building secure and interoperable wallet infrastructure for the blooming cross-chain networks, placing its core mainly at the Cosmos ecosystem.
Expand All @@ -24,15 +25,15 @@ To make a pull request, please carefully read and follow the guidelines below. A
# Requirements and Preparation
This section outlines the basic information that is required for registering a chain to Keplr wallet. Please note that your request does not always guarantee integrations and updates; upon your submission, Keplr team will go through a minimal verification process to see if there is any security issue or any missing information.
This section outlines the basic information that is required for registering a chain to Keplr wallet. Please note that your request does not always guarantee integrations and updates; upon your submission, Keplr team will go through a minimal verification process to see if there is any security issue or any missing information.
Once approved, the Keplr browser extension will show the tag “Community-Driven” on the chain connection page, to let the users be aware that the integration was requested and implemented by the community and the Keplr team has gone through the verification process.
<p align="center">
<img src="https://i.imgur.com/f9UEOIR.png" alt="Sample Image"/>
</p>
## Chain Registration Directory Structure
## Cosmos-SDK-based Chain Registration Directory Structure
chainID is consisted of ({identifier}-{version}). **`chain-identifier`** therefore refers to a text identifier of a chain that comes before its version number. For example:
Expand All @@ -58,7 +59,7 @@ Here’s an overview of the structure of the directory. Please provide the infor
└── ...
```
## Chain Registration Form
### Cosmos-SDK-based Chain Registration Form
```json
{
Expand All @@ -70,7 +71,7 @@ Here’s an overview of the structure of the directory. Please provide the infor
"nodeProvider": {
"name": "Blockapsis",
"email": "[email protected]",
"website":"https://blockapsis.com/"
"website": "https://blockapsis.com/"
},
"bip44": {
"coinType": 118
Expand Down Expand Up @@ -110,14 +111,11 @@ Here’s an overview of the structure of the directory. Please provide the infor
"coinDecimals": 6,
"coinGeckoId": "osmosis"
},
"features": [
"cosmwasm",
"osmosis-txfees"
]
"features": ["cosmwasm", "osmosis-txfees"]
}
```
## Requirement Details
### Cosmos-SDK-based Chain Registration Form Requirement Details
- chainId: chainId in a form of {identifier}-{version} (ex. cosmoshub-4)
- chainName: the name of the chain that will be displayed on the wallet
Expand All @@ -127,31 +125,127 @@ Here’s an overview of the structure of the directory. Please provide the infor
- rpc: URL of RPC endpoint of the chain
- rest: URL of REST/API endpoint of the chain
- nodeProvider: provide the details of the RPC/REST node providers
- name: name of the node provider
- email: email address of the node provider (To help other users reach out when there is an issue with the nodes’ status)
- website(optional): website address of the node provider
- name: name of the node provider
- email: email address of the node provider (To help other users reach out when there is an issue with the nodes’ status)
- website(optional): website address of the node provider
- walletUrlForStaking(optional): the URL where the users are directed when they click on Staking button of the Keplr Wallet
- bip44: BIP-44 coin type (118 highly recommended)
- bech32Config: prefix used at the beginning of the address
- currencies: the list of the supported currencies
- currencies: the list of the supported currencies. If your chain uses replicated security, please place your main native token at the top of the currencies list.
- feeCurrencies: the list of the tokens that are accepted by the validators for fees
- stakeCurrency: the staking token of the chain
- stakeCurrency: the staking token of the chain. Remove this item if your chain does not support native staking (e.g. your chain uses replicated security) or does not have a staking token.
- coinGeckoId(optional): the active API ID for Keplr to get the price from CoinGecko
- features: any other features that are additionally supported by the chain
- cosmwasm: supports CosmWasm smart contracts
- secretwasm: supports WASM smart contracts of Secret Network
- eth-address-gen: supports EVM account generation
- eth-key-sign: supports EVM signatures
- axelar-evm-bridge: supports EVM bridge provided by Axelar Network
- osmosis-txfees: supports paying fees in other currencies on Osmosis
## EVM-based Chain Registration Directory Structure
EVM-based chain identifier is consisted of eip155:{eip155-chain-id} which follows [CAIP-2](https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-2.md)
```
The chain identifier of `Ethereum` is `eip155:1`.
The chain identifier of `Optimism` is `eip155:10`.
The chain identifier of `Polygon` is `eip155:137`.
```
Here’s an overview of the structure of the directory. Please provide the information and files complying with the requirements.
```
.
├── evm
│ ├── eip155:1.json # Chains (Each file should be named `{chain-identifier}.json')
│ ├── eip155:10.json
│ └── ...
└── images # Collection of image assets
├── eip155:1 # Image assets of Ethereum (Each directory should be named `{chain-identifier}`.)
│ ├── erc20
│ │ └── {contract address}.png # Ethereum ERC20 token logo(png, 256x256px)
│ ├── chain.png # Ethereum logo(png, 256x256px)
│ └── ethereum-native.png # Etherem native token logo(png, 256x256px)
├── eip155.10
└── ...
```
### EVM-based Chain Registration Form
```json
{
"rpc": "https://evm-1.keplr.app",
"websocket": "wss://evm-1.keplr.app/websocket",
"nodeProvider": {
"name": "Keplr",
"email": "[email protected]",
"website": "https://keplr.app"
},
"chainId": "eip155:1",
"chainName": "Ethereum",
"chainSymbolImageUrl": "https://raw.githubusercontent.com/chainapsis/keplr-chain-registry/main/images/eip155:1/chain.png",
"bip44": {
"coinType": 60
},
"currencies": [
{
"coinDenom": "ETH",
"coinMinimalDenom": "ethereum-native",
"coinDecimals": 18,
"coinGeckoId": "ethereum",
"coinImageUrl": "https://raw.githubusercontent.com/chainapsis/keplr-chain-registry/main/images/eip155:1/ethereum-native.png"
},
{
"coinDenom": "USDC",
"coinMinimalDenom": "erc20:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
"coinDecimals": 6,
"coinGeckoId": "usd-coin",
"coinImageUrl": "https://raw.githubusercontent.com/chainapsis/keplr-chain-registry/main/images/eip155:1/erc20/0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48.png"
}
],
"feeCurrencies": [
{
"coinDenom": "ETH",
"coinMinimalDenom": "ethereum-native",
"coinDecimals": 18,
"coinGeckoId": "ethereum",
"coinImageUrl": "https://raw.githubusercontent.com/chainapsis/keplr-chain-registry/main/images/eip155:1/ethereum-native.png"
}
],
"features": []
}
```
### EVM-based Chain Registration Form Requirement Details
- rpc: URL of RPC endpoint of the chain
- websocket: URL of WebSocket endpoint of the chain
- nodeProvider: provide the details of the RPC/WebSocket node providers
- name: name of the node provider
- email: email address of the node provider (To help other users reach out when there is an issue with the nodes’ status)
- website(optional): website address of the node provider
- chainId: chain identifier in a form of eip155:{evm-chain-id} (ex. eip155:1)
- chainName: the name of the chain that will be displayed on the wallet
- chainSymbolImageUrl: Image URL of the chain.
- https://raw.githubusercontent.com/chainapsis/keplr-chain-registry/main/images/{chain-identifier}/{file-name}.png
- Please modify the chain-identifier and file-name from the link above and upload it.
- bip44: BIP-44 coin type (60 highly recommended)
- currencies: the list of the supported currencies. If your chain uses replicated security, please place your main native token at the top of the currencies list.
- feeCurrencies: the list of the tokens that are accepted for fees
- coinGeckoId(optional): the active API ID for Keplr to get the price from CoinGecko
- features: any other features that are additionally supported by the chain
- cosmwasm: supports CosmWasm smart contracts
- secretwasm: supports WASM smart contracts of Secret Network
- eth-address-gen: supports EVM account generation
- eth-key-sign: supports EVM signatures
- axelar-evm-bridge: supports EVM bridge provided by Axelar Network
- osmosis-txfees: supports paying fees in other currencies on Osmosis
- op-stack-l1-data-fee: supports paying L1 data fee for OP stack based chain
## NOTE:
- please check if the chain information file is in JSON format.
- Chain logos should be in PNG format in 256x256px resolution. Please also note that the images will be automatically cropped into a circle to be displayed on the wallet (See the sample image above)
- RPC
- Please check if the RPC node is not currently experiencing any issues/errors.
- Please double-check if your chainId matches the RPC node’s chainId.
- Check if websocket connection is open.
- RPC / WebSocket
- Please check if the RPC node is not currently experiencing any issues/errors.
- Please double-check if your chainId matches the RPC node’s chainId.
- Check if websocket connection is open.
- REST
- Please check if the REST node is not currently experiencing any issues/errors.
- Please double-check if your chainId matches the REST node’s chainId.
- Please check if the REST node is not currently experiencing any issues/errors.
- Please double-check if your chainId matches the REST node’s chainId.
- Please provide the CoinGecko ID only if the price for the token is available on CoinGecko.
2 changes: 1 addition & 1 deletion cosmos/90u.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"email": "[email protected]",
"website":"https://itrocket.net/"
},
"chainId": "90u-2",
"chainId": "90u-4",
"chainName": "Terp Testnet",
"chainSymbolImageUrl": "https://raw.githubusercontent.com/chainapsis/keplr-chain-registry/main/images/90u/chain.png",
"stakeCurrency": {
Expand Down
50 changes: 50 additions & 0 deletions cosmos/HICKORY.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
{
"chainId": "HICKORY",
"chainName": "HICKORY-TEST",
"chainSymbolImageUrl": "https://raw.githubusercontent.com/chainapsis/keplr-chain-registry/main/images/HICKORY/logo_hic.png",
"rpc": "http://test.hickoryblockchain.com:26657/",
"rest": "http://test.hickoryblockchain.com:1317/",
"nodeProvider": {
"name": "Hickory Blockchain Development",
"email": "[email protected]",
"website":"https://www.hickoryblockchain.com/"
},
"bip44": {
"coinType": 118
},
"bech32Config": {
"bech32PrefixAccAddr": "hic",
"bech32PrefixAccPub": "hicpub",
"bech32PrefixValAddr": "hicvaloper",
"bech32PrefixValPub": "hicvaloperpub",
"bech32PrefixConsAddr": "hicvalcons",
"bech32PrefixConsPub": "hicvalconspub"
},
"currencies": [
{
"coinDenom": "HIC",
"coinMinimalDenom": "uhic",
"coinDecimals": 6
}
],
"feeCurrencies": [
{
"coinDenom": "HIC",
"coinMinimalDenom": "uhic",
"coinDecimals": 6,
"gasPriceStep": {
"low": 0.01,
"average": 0.025,
"high": 0.03
}
}
],
"stakeCurrency": {
"coinDenom": "HIC",
"coinMinimalDenom": "uhic",
"coinDecimals": 6
},
"features": [
"cosmwasm"
]
}
10 changes: 5 additions & 5 deletions cosmos/LumenX.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"chainId": "LumenX",
"chainName": "LumenX",
"chainSymbolImageUrl": "https://raw.githubusercontent.com/chainapsis/keplr-chain-registry/main/images/LumenX/chain.png",
"rpc": "https://lumenx-rpc.kynraze.com",
"rest": "https://lumenx-api.kynraze.com",
"rpc": "https://rpc-lumenx.cryptonet.pl",
"rest": "https://api-lumenx.cryptonet.pl",
"nodeProvider": {
"name": "Kynraze",
"email": "[email protected]",
"website": "https://kynraze.com"
"name": "CryptoNet",
"email": "[email protected]",
"website": "https://cryptonet.pl"
},
"walletUrlForStaking": "https://explorer.kynraze.com/lumenx/staking",
"bip44": {
Expand Down
51 changes: 0 additions & 51 deletions cosmos/aggevm.json

This file was deleted.

Loading

0 comments on commit a3634c5

Please sign in to comment.