Getting Started

Connect to Polkadot using OneKey's Polkadot.js-compatible provider

Learn how to detect, connect, and interact with Polkadot and Substrate chains.

OneKey implements the Polkadot.js extension interface, ensuring compatibility with all Substrate dApps.

---

Provider Detection

// OneKey registers as a Polkadot.js extension
const provider = window.$onekey?.polkadot

// Or use the standard web3Enable API

---

Enable Extension

// Using OneKey provider directly
const enabled = await provider.web3Enable('My dApp')

if (enabled) {
  const accounts = await provider.web3Accounts()
  console.log('Accounts:', accounts)
}

---

Using Polkadot.js Extension API (Recommended)

// Enable all extensions (including OneKey)
const extensions = await web3Enable('My dApp')

if (extensions.length === 0) {
  throw new Error('No extension found')
}

// Get all accounts
const allAccounts = await web3Accounts()
console.log('Accounts:', allAccounts)

---

Get Accounts

const accounts = await provider.web3Accounts()

accounts.forEach(account => {
  console.log({
    address: account.address,     // Substrate address
    name: account.name,           // Account name
    type: account.type,           // 'sr25519' | 'ed25519' | 'ecdsa'
    genesisHash: account.genesisHash, // Optional chain genesis
  })
})

---

Subscribe to Account Changes

const unsubscribe = provider.web3AccountsSubscribe((accounts) => {
  console.log('Accounts changed:', accounts)
})

// Later: unsubscribe()

---

Using with Polkadot.js API

Setup

npm install @polkadot/api @polkadot/extension-dapp

Connect and Sign Transaction

// Enable extensions
await web3Enable('My dApp')

// Get accounts
const accounts = await web3Accounts()
const account = accounts[0]

// Connect to chain
const wsProvider = new WsProvider('wss://rpc.polkadot.io')
const api = await ApiPromise.create({ provider: wsProvider })

// Get injector
const injector = await web3FromAddress(account.address)

// Create and sign transaction
const tx = api.tx.balances.transfer(
  recipientAddress,
  1000000000000 // 1 DOT (10^12 planck)
)

// Sign and send
const hash = await tx.signAndSend(
  account.address,
  { signer: injector.signer }
)

console.log('Transaction hash:', hash.toHex())