Skip to main content

Introduction

Welcome to OneKey’s Developer Documentation. This documentation is for learning to develop applications for OneKey.

Why OneKey Browser Extension#

OneKey was created to meet the needs of secure and usable Ethereum-based web sites. In particular, it handles account management and connecting the user to the blockchain.

Account Management#

OneKey Browser Extension allows users to manage accounts and their keys in a variety of ways, including hardware wallets, while isolating them from the site context. This is a great security improvement over storing the user keys on a single central server, or even in local storage, which can allow for mass account thefts.

This security feature also comes with developer convenience: For developers, you simply interact with the globally available ethereum API that identifies the users of web3-compatible browsers (like OneKey users), and whenever you request a transaction signature (like eth_sendTransaction, eth_signTypedData, or others), OneKey will prompt the user in as comprehensible a way as possible.

Blockchain Connection#

OneKey comes pre-loaded with fast connections to the Ethereum blockchain and several test networks. This allows you to get started without synchronizing a full node, while still providing the option to upgrade your security and use the blockchain provider of your choice.

Today, OneKey is compatible with any blockchain that exposes an Ethereum-compatible JSON RPC API, including custom and private blockchains. For development, we recommend running a test blockchain like Ganache.

We’re aware that there are constantly new private blockchains that people are interested in connecting OneKey to, and we are building towards easier integration with these many options.