Interface: Keplr

Properties

defaultOptions

• defaultOptions: KeplrIntereactionOptions

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:43

---

mode

• Readonly mode: KeplrMode

mode means that how Keplr is connected. If the connected Keplr is browser's extension, the mode should be "extension". If the connected Keplr is on the mobile app with the embeded web browser, the mode should be "mobile-web".

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:42

---

version

• Readonly version: string

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:36

Methods

changeKeyRingName

▸ changeKeyRingName(opts): Promise<string>

Change wallet extension user name *

Parameters

Name	Type
opts	Object
opts.defaultName	string
opts.editable?	boolean

Returns

Promise<string>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:122

---

disable

▸ disable(chainIds?): Promise<void>

Delete permissions granted to origin. If chain ids are specified, only the permissions granted to each chain id are deleted (In this case, permissions such as getChainInfosWithoutEndpoints() are not deleted). Else, remove all permissions granted to origin (In this case, permissions that are not assigned to each chain, such as getChainInfosWithoutEndpoints(), are also deleted).

Parameters

Name	Type	Description
chainIds?	string | string[]	disable(Remove approve domain(s)) target chain ID(s).

Returns

Promise<void>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:53

---

enable

▸ enable(chainIds): Promise<void>

Parameters

Name	Type
chainIds	string | string[]

Returns

Promise<void>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:45

---

enigmaDecrypt

▸ enigmaDecrypt(chainId, ciphertext, nonce): Promise<Uint8Array>

Parameters

Name	Type
chainId	string
ciphertext	Uint8Array
nonce	Uint8Array

Returns

Promise<Uint8Array>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:98

---

enigmaEncrypt

▸ enigmaEncrypt(chainId, contractCodeHash, msg): Promise<Uint8Array>

Parameters

Name	Type
chainId	string
contractCodeHash	string
msg	object

Returns

Promise<Uint8Array>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:97

---

experimentalSignEIP712CosmosTx_v0

▸ experimentalSignEIP712CosmosTx_v0(chainId, signer, eip712, signDoc, signOptions?): Promise<AminoSignResponse>

Sign the sign doc with ethermint's EIP-712 format. The difference from signEthereum(..., EthSignType.EIP712) is that this api returns a new sign doc changed by the user's fee setting and the signature for that sign doc. Encoding tx to EIP-712 format should be done on the side using this api. Not compatible with cosmjs. The returned signature is (r | s | v) format which used in ethereum. v should be 27 or 28 which is used in the ethereum mainnet regardless of chain.

Parameters

Name	Type
chainId	string
signer	string
eip712	Object
eip712.domain	Record<string, any>
eip712.primaryType	string
eip712.types	Record<string, undefined | { name: string ; type: string }[]>
signDoc	StdSignDoc
signOptions?	KeplrSignOptions

Returns

Promise<AminoSignResponse>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:112

---

experimentalSuggestChain

▸ experimentalSuggestChain(chainInfo): Promise<void>

Parameters

Name	Type
chainInfo	ChainInfo

Returns

Promise<void>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:44

---

getChainInfosWithoutEndpoints

▸ getChainInfosWithoutEndpoints(): Promise<ChainInfoWithoutEndpoints[]>

Returns

Promise<ChainInfoWithoutEndpoints[]>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:120

---

getEnigmaPubKey

▸ getEnigmaPubKey(chainId): Promise<Uint8Array>

Parameters

Name	Type
chainId	string

Returns

Promise<Uint8Array>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:95

---

getEnigmaTxEncryptionKey

▸ getEnigmaTxEncryptionKey(chainId, nonce): Promise<Uint8Array>

Parameters

Name	Type
chainId	string
nonce	Uint8Array

Returns

Promise<Uint8Array>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:96

---

getEnigmaUtils

▸ getEnigmaUtils(chainId): SecretUtils

Parameters

Name	Type
chainId	string

Returns

SecretUtils

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:94

---

getKey

▸ getKey(chainId): Promise<Key>

Parameters

Name	Type
chainId	string

Returns

Promise<Key>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:54

---

getKeysSettled

▸ getKeysSettled(chainIds): Promise<SettledResponses<Key>>

Parameters

Name	Type
chainIds	string[]

Returns

Promise<SettledResponses<Key>>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:55

---

getOfflineSigner

▸ getOfflineSigner(chainId, signOptions?): OfflineAminoSigner & OfflineDirectSigner

Parameters

Name	Type
chainId	string
signOptions?	KeplrSignOptions

Returns

OfflineAminoSigner & OfflineDirectSigner

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:89

---

getOfflineSignerAuto

▸ getOfflineSignerAuto(chainId, signOptions?): Promise<OfflineAminoSigner | OfflineDirectSigner>

Parameters

Name	Type
chainId	string
signOptions?	KeplrSignOptions

Returns

Promise<OfflineAminoSigner | OfflineDirectSigner>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:91

---

getOfflineSignerOnlyAmino

▸ getOfflineSignerOnlyAmino(chainId, signOptions?): OfflineAminoSigner

Parameters

Name	Type
chainId	string
signOptions?	KeplrSignOptions

Returns

OfflineAminoSigner

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:90

---

getSecret20ViewingKey

▸ getSecret20ViewingKey(chainId, contractAddress): Promise<string>

Parameters

Name	Type
chainId	string
contractAddress	string

Returns

Promise<string>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:93

---

sendTx

▸ sendTx(chainId, tx, mode): Promise<Uint8Array>

Parameters

Name	Type
chainId	string
tx	Uint8Array
mode	BroadcastMode

Returns

Promise<Uint8Array>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:84

---

signAmino

▸ signAmino(chainId, signer, signDoc, signOptions?): Promise<AminoSignResponse>

Parameters

Name	Type
chainId	string
signer	string
signDoc	StdSignDoc
signOptions?	KeplrSignOptions

Returns

Promise<AminoSignResponse>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:56

---

signArbitrary

▸ signArbitrary(chainId, signer, data): Promise<StdSignature>

Parameters

Name	Type
chainId	string
signer	string
data	string | Uint8Array

Returns

Promise<StdSignature>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:86

---

signDirect

▸ signDirect(chainId, signer, signDoc, signOptions?): Promise<DirectSignResponse>

Parameters

Name	Type	Description
chainId	string	-
signer	string	-
signDoc	Object	-
signDoc.accountNumber?	null | Long	SignDoc accountNumber
signDoc.authInfoBytes?	null | Uint8Array	SignDoc authInfoBytes
signDoc.bodyBytes?	null | Uint8Array	SignDoc bodyBytes
signDoc.chainId?	null | string	SignDoc chainId
signOptions?	KeplrSignOptions	-

Returns

Promise<DirectSignResponse>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:57

---

signDirectAux

▸ signDirectAux(chainId, signer, signDoc, signOptions?): Promise<DirectAuxSignResponse>

Parameters

Name	Type
chainId	string
signer	string
signDoc	Object
signDoc.accountNumber?	null | Long
signDoc.bodyBytes?	null | Uint8Array
signDoc.chainId?	null | string
signDoc.publicKey?	null | { typeUrl: string ; value: Uint8Array }
signDoc.sequence?	null | Long
signDoc.tip?	null | { amount: { amount: string ; denom: string }[] ; tipper: string }
signOptions?	KeplrSignOptions

Returns

Promise<DirectAuxSignResponse>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:67

---

signEthereum

▸ signEthereum(chainId, signer, data, type): Promise<Uint8Array>

Parameters

Name	Type
chainId	string
signer	string
data	string | Uint8Array
type	EthSignType

Returns

Promise<Uint8Array>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:88

---

signICNSAdr36

▸ signICNSAdr36(chainId, contractAddress, owner, username, addressChainIds): Promise<ICNSAdr36Signatures>

Parameters

Name	Type
chainId	string
contractAddress	string
owner	string
username	string
addressChainIds	string[]

Returns

Promise<ICNSAdr36Signatures>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:85

---

suggestToken

▸ suggestToken(chainId, contractAddress, viewingKey?): Promise<void>

Parameters

Name	Type
chainId	string
contractAddress	string
viewingKey?	string

Returns

Promise<void>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:92

---

verifyArbitrary

▸ verifyArbitrary(chainId, signer, data, signature): Promise<boolean>

Parameters

Name	Type
chainId	string
signer	string
data	string | Uint8Array
signature	StdSignature

Returns

Promise<boolean>

Defined in

node_modules/@keplr-wallet/types/build/wallet/keplr.d.ts:87