On this page

API Reference

Reference for OneKey’s Cosmos provider methods and types.

Methods

Method	Description
`enable(chainIds)`	Request access to chain(s); resolves without a value
`disable(chainIds)`	Disable chain(s)
`disconnect()`	Disconnect from all chains
`getKey(chainId)`	Get account key for chain
`signAmino(chainId, signer, signDoc)`	Sign Amino-encoded transaction
`signDirect(chainId, signer, signDoc)`	Sign Protobuf-encoded transaction
`sendTx(chainId, tx, mode)`	Broadcast signed transaction
`signArbitrary(chainId, signer, data)`	Sign arbitrary message
`verifyArbitrary(chainId, signer, data, signature)`	Verify signature
`signEthereum(chainId, signer, data, type)`	Sign Ethereum data
`experimentalSuggestChain(chainInfo)`	Add custom chain
`getOfflineSigner(chainId)`	Get Direct offline signer
`getOfflineSignerOnlyAmino(chainId)`	Get Amino-only offline signer
`getOfflineSignerAuto(chainId)`	Auto-detect best signer type
`getChainInfosWithoutEndpoints()`	Get all chain infos
`getChainInfoWithoutEndpoints(chainId)`	Get specific chain info
`ping()`	Check connection
`babylonConnectWallet()`	Connect to Babylon wallet
`babylonGetKey()`	Get Babylon wallet key

Key Interface


interface Key {
  name: string              // Human-readable name
  algo: string              // Signing algorithm
  pubKey: Uint8Array        // Public key bytes
  address: Uint8Array       // Address bytes
  bech32Address: string     // Bech32 formatted address
  isNanoLedger: boolean     // Ledger compatibility flag
  isKeystone: boolean       // True if Keystone hardware
}

Sign Doc Types

Amino Sign Doc


interface StdSignDoc {
  chain_id: string
  account_number: string
  sequence: string
  fee: {
    amount: { denom: string; amount: string }[]
    gas: string
  }
  msgs: {
    type: string
    value: any
  }[]
  memo: string
}

Direct Sign Doc


interface DirectSignDoc {
  bodyBytes: Uint8Array | null
  authInfoBytes: Uint8Array | null
  chainId: string | null
  accountNumber: Long | null
}

Sign Response Types


interface AminoSignResponse {
  signed: StdSignDoc
  signature: StdSignature
}
 
interface DirectSignResponse {
  signed: DirectSignDoc
  signature: StdSignature
}
 
interface StdSignature {
  pub_key: {
    type: string
    value: string  // Base64 encoded
  }
  signature: string  // Base64 encoded
}

Broadcast Modes

Mode	Description
`block`	Wait for block inclusion
`sync`	Wait for CheckTx
`async`	Return immediately

Supported Chains

Chain	Chain ID	Wallet Availability
Cosmos Hub	`cosmoshub-4`	Verify in the target wallet
Osmosis	`osmosis-1`	Verify in the target wallet
Juno	`juno-1`	Verify in the target wallet
Stargaze	`stargaze-1`	Verify in the target wallet
Akash	`akashnet-2`	Verify in the target wallet
Secret Network	`secret-4`	Verify in the target wallet
Evmos	`evmos_9001-2`	Verify in the target wallet
Injective	`injective-1`	Verify in the target wallet
Custom	Chain-specific	Request with `experimentalSuggestChain`; acceptance is not guaranteed

Events

Event	Description
`keplr_keystorechange`	Account or key changed
`connect`	Connected to chain
`disconnect`	Disconnected


// Listen for keystore changes
window.addEventListener('keplr_keystorechange', () => {
  console.log('Key changed, refresh account info')
})

Error Codes

Code	Description
4001	User rejected request
4100	Unauthorized
-32603	Internal error