# How to detect Keplr
Keplr API may be undefined right after the webpage is shown. Please check the How to detect Keplr first before reading this section.
# Connecting with CosmJS
CosmJS link: https://www.npmjs.com/package/@cosmjs/launchpad (opens new window), https://www.npmjs.com/package/@cosmjs/stargate (opens new window)
You can connect Keplr to CosmJS using the
To get the
OfflineSigner, you may use
window.getOfflineSigner is an alias that runs
keplr.getOfflineSigner and returns the value)
window.keplr.enable(chainId) method will request the user to unlock their Keplr extension if it's locked. If the user has not given permission to connect their extension to the website, it will first ask to connect the website.
If the user cancels the unlock or rejects the permission to connect, an error will be thrown.
If the extension is already unlocked and the website has permission to connect, no action will happen and resolve.
window.keplr.enable(chainId) is not mandatory. Even if the method wasn't called, if an API that requests access to Keplr is called the flow above will automatically run. However, it is recommended that
window.keplr.enable(chainId) is first run.
# Types of Offline Signers
In CosmJS, there are two types of Signers: OfflineSigner and OfflineDirectSigner. OfflineSigner is used to sign SignDoc serialized with Amino in Cosmos SDK Launchpad (Cosmos SDK v0.39.x or below). OfflineDirectSigner is used to sign Protobuf encoded SignDoc.
Keplr supports both types of Signers. Keplr’s
window.getOfflineSigner(chainId) returns a Signer that satisfies both the OfflineSigner and OfflineDirectSigner. Therefore, when using CosmJS with this Signer, Amino is used for Launchpad chains and Protobuf is used for Stargate chains.
However, if the msg to be sent is able to be serialized/deserialized using Amino codec you can use a signer for Amino. Also, as there are some limitations to protobuf type sign doc, there may be cases when Amino is necessary. For example, Protobuf formatted sign doc is currently not supported by Ledger Nano’s Cosmos app. Also, because protobuf sign doc is binary formatted, msgs not natively supported by Keplr may not be human-readable.
If you’d like to enforce the use of Amino, you can use the following APIs:
window.getOfflineSignerOnlyAmino(chainId: string). Because this will always return an Amino compatible signer, any CosmJS requested msg that is Amino compatible will request an Amino SignDoc to Keplr.
keplr.getOfflineSignerAuto(chainId: string): Promise<OfflineSigner | OfflineDirectSigner> or
window.getOfflineSignerAuto(chainId: string): Promise<OfflineSigner | OfflineDirectSigner> API is supported. Please note that the value returned is async. This API automatically returns a signer that only supports Amino if the account is a Ledger-based account, and returns a signer that is compatible for both Amino and Protobuf if the account is a mnemonic/private key-based account. Because this API is affected by the type of the connected Keplr account, if keplr_keystorechange event is used to detect account changes the signer must be changed using the API when this event has been triggered.
# Use with Stargate
OfflineSigner implements the
OfflineDirectSigner interface. Use
SigningStargateClient with Keplr's
OfflineSigner, and Keplr will sign the transaction in Proto sign doc format.
Refer to the keplr-example (opens new window) repository for example code on how to integrate Keplr with CosmJS.
# Interaction Options
You can use Keplr native API’s to set interaction options even when using CosmJS. Please refer to this section.
# Adding a custom blockchain to Keplr
If Keplr doesn't natively support your blockchain within the extension, please refer to the Suggest chain section.