Protocol for Integrating Non-Native Chains to Keplr
Protocol for Integrating Non-Native Chains to Keplr
Warning
PLEASE RUN THE COMMANDS BELOW TO VERIFY CONFIGURATION IN YOUR LOCAL ENVIRONMENT BEFORE SUBMITTING PULL REQUESTS.
# install node modules yarn install # validate your json file (for Cosmos-SDK-based chains, EVM chains, or SVM chains) yarn validate cosmos/{your file.json} yarn validate evm/{your file.json} yarn validate svm/{your file.json}READ THE GUIDELINES BELLOW CAREFULLY, PAYING PARTICULAR ATTENTION TO THE "features" IN THE [REQUIREMENT DETAILS for Cosmos-based chains] and [REQUIREMENT DETAILS for EVM-based chains].
Keplr team has always been at the leading edge of building secure and interoperable wallet infrastructure for the blooming cross-chain networks. While Keplr initially focused its core efforts on the Cosmos ecosystem (collectively known as the "interchain ecosystem"), it has since expanded to support EVM-compatible chains and Starknet, with plans to further extend into other ecosystems, leveraging thoughtfully designed UI/UX for enhanced compatibility across technologies.
To help the builders easily plug into Keplr’s wide userbase and the ever-growing crypto ecosystems, Keplr has been offering an option of permissionless integration, the so-called “Suggest (Non-Native) Chain Integration”. The feature has enabled front-ends to request adding new blockchains that aren’t natively integrated into the Keplr extension.
Keplr team is now introducing a Community-Driven Integration, which enables our users to easily make a request for adding new chains and updating their information. It's an expanded version of the previous suggest chain integration, providing a public API to our users for creating and updating a set integration standard for each chain.
To make a pull request, please carefully read and follow the guidelines below. Any contribution is more than welcome!
This guildline 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.
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:
The chain-identifier of `cosmoshub-4` is `cosmoshub`.
The chain-identifier of `crypto-org-chain-mainnet-1` is `crypto-org-chain-mainnet`.
The chain-identifier of `evmos_9001-2` is `evmos_9001`.
The chain-identifier of 'shentu-2.2' is 'shentu-2.2'.Here’s an overview of the structure of the directory. Please provide the information and files complying with the requirements.
.
├── cosmos # Mainnet
│ ├── cosmoshub.json # Chains (Each file should be named `{chain-identifier}.json')
│ ├── osmosis.json
│ └── ...
└── images # Collection of image assets
├── cosmoshub # Image assets of Comos Hub (Each directory should be named `{chain-identifier}`.)
│ └── chain.png # Cosmos Hub Logo(png, 256x256px)
├── osmosis # Image assets of Osmosis
└── ...…{txHash} - transaction hash in uppercase hex{txHash:lowercase} - transaction hash in lowercase hex{txHash:uppercase} - transaction hash in uppercase hex (same as {txHash})"https://www.mintscan.io/osmosis/tx/{txHash}"EVM-based chain identifier is consisted of eip155:{eip155-chain-id} which follows CAIP-2
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.
……{txHash} - transaction hash in uppercase hex{txHash:lowercase} - transaction hash in lowercase hex{txHash:uppercase} - transaction hash in uppercase hex (same as {txHash})"https://etherscan.io/tx/0x{txHash}""https://lineascan.build/tx/0x{txHash:lowercase}"SVM-based chain identifier follows CAIP-2 format with {namespace}:{reference} structure, where reference is a base58 encoded hash.
The chain identifier of `Solana Mainnet` is `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`.
The chain identifier of `Solana Devnet` is `solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1`.Here's an overview of the structure of the directory. Please provide the information and files complying with the requirements.
……{txHash} - transaction hash in uppercase hex{txHash:lowercase} - transaction hash in lowercase hex{txHash:uppercase} - transaction hash in uppercase hex (same as {txHash})"https://explorer.solana.com/tx/{txHash}"coinImageUrl is not provided in currencies, Keplr doesn't show the token image on the wallet.No open issues yet, or sync has not completed.