Skip to Content
dApp 接入Polkadot
本页目录

Polkadot

使用 OneKey 的 Provider 集成 Polkadot 和基于 Substrate 的链。通过 window.$onekey.polkadot 或 Polkadot.js 扩展 API 访问。

OneKey 通过 Polkadot.js 扩展接口提供本文列出的操作。

快速链接

Provider 检测

// OneKey registers as a Polkadot.js extension
const provider = window.$onekey?.polkadot
 
// Or use the standard web3Enable API
import { web3Enable, web3Accounts } from '@polkadot/extension-dapp'

快速开始

启用扩展

// Using OneKey provider directly
const enabled = await provider.web3Enable('My dApp')
 
if (enabled) {
  const accounts = await provider.web3Accounts()
  console.log('Accounts:', accounts)
}

使用 Polkadot.js 扩展 API（推荐）

import { web3Enable, web3Accounts } from '@polkadot/extension-dapp'
 
// 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)

账户管理

获取账户

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
  })
})

订阅账户变化

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

签名

签名交易 Payload

签名 extrinsic payloads：

import { web3FromAddress } from '@polkadot/extension-dapp'
 
// Get injector for specific account
const injector = await web3FromAddress(accountAddress)
 
// Sign payload
const payload = {
  address: accountAddress,
  blockHash: '0x...',
  blockNumber: '0x...',
  era: '0x...',
  genesisHash: '0x...',
  method: '0x...',
  nonce: '0x...',
  specVersion: '0x...',
  tip: '0x...',
  transactionVersion: '0x...',
  signedExtensions: [], // Populate from current chain metadata; do not sign this placeholder
  version: 4,
}
 
const result = await provider.web3SignPayload(payload)
 
console.log({
  id: result.id,
  signature: result.signature, // Hex signature
})

签名原始消息

const payload = {
  address: accountAddress,
  data: '0x48656c6c6f', // Hex-encoded message
  type: 'bytes',
}
 
const result = await provider.web3SignRaw(payload)
 
console.log({
  id: result.id,
  signature: result.signature,
})

配合 Polkadot.js API 使用

设置

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

连接并签名交易

import { ApiPromise, WsProvider } from '@polkadot/api'
import { web3Enable, web3FromAddress, web3Accounts } from '@polkadot/extension-dapp'
 
// Enable extensions
await web3Enable('My dApp')
 
// Get accounts
const accounts = await web3Accounts()
const account = accounts[0]
if (!account) throw new Error("No account was selected")
 
// 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.transferKeepAlive(
  recipientAddress,
  '10000000000' // 1 DOT = 10^10 planck on Polkadot
)
 
// Sign and send
const hash = await tx.signAndSend(
  account.address,
  { signer: injector.signer }
)
 
console.log('Transaction hash:', hash.toHex())

监听交易事件

await tx.signAndSend(
  account.address,
  { signer: injector.signer },
  ({ status, events }) => {
    if (status.isInBlock) {
      console.log('In block:', status.asInBlock.toHex())
    }
    if (status.isFinalized) {
      console.log('Finalized:', status.asFinalized.toHex())
 
      events.forEach(({ event }) => {
        if (api.events.system.ExtrinsicSuccess.is(event)) {
          console.log('Transaction succeeded')
        }
        if (api.events.system.ExtrinsicFailed.is(event)) {
          console.log('Transaction failed')
        }
      })
    }
  }
)

RPC 方法

发送 RPC 请求

const response = await provider.web3RpcSend({
  method: 'chain_getHeader',
  params: [],
})
 
console.log('Latest header:', response.result)

订阅 RPC 事件

const subscriptionId = await provider.web3RpcSubscribe(
  {
    method: 'chain_subscribeNewHeads',
    params: [],
  },
  (response) => {
    console.log('New block:', response.result)
  }
)
 
// Unsubscribe later
await provider.web3RpcUnSubscribe()

列出可用 Provider

const providers = await provider.web3RpcListProviders()
console.log('Available providers:', providers)

API 参考

方法

方法说明
web3Enable(dappName)为 dApp 启用扩展
web3Accounts(anyType?)获取所有账户
web3AccountsSubscribe(callback)订阅账户变化
web3SignPayload(payload)签名交易 payload
web3SignRaw(payload)签名原始消息
web3RpcSend(request)发送 RPC 请求
web3RpcSubscribe(request, callback)订阅 RPC 事件
web3RpcUnSubscribe()取消所有订阅
web3RpcListProviders()列出 RPC providers
web3RpcStartProvider(key)启动特定 provider

类型

interface InjectedAccount {
  address: string          // Substrate address
  name?: string            // Account name
  type?: 'sr25519' | 'ed25519' | 'ecdsa'
  genesisHash?: string     // Optional chain restriction
}
 
interface SignerPayloadJSON {
  address: string
  blockHash: string
  blockNumber: string
  era: string
  genesisHash: string
  method: string
  nonce: string
  specVersion: string
  tip: string
  transactionVersion: string
  signedExtensions: string[]
  version: number
}
 
interface SignerPayloadRaw {
  address: string
  data: string             // Hex-encoded data
  type: 'bytes' | 'payload'
}
 
interface SignerResult {
  id: number
  signature: string        // Hex signature
}

支持的链

链说明
Polkadot主中继链
Kusama先行网络
AcalaDeFi 平台
Moonbeam兼容 EVM
Astar智能合约平台
其他 Substrate 链使用前验证钱包和 runtime 支持情况

错误处理

try {
  const result = await provider.web3SignPayload(payload)
} catch (error) {
  if (error.message === 'Cancelled') {
    console.log('User cancelled signing')
  } else {
    console.error('Signing failed:', error)
  }
}

配合 React 使用

import { useState, useEffect } from 'react'
import { web3Enable, web3Accounts } from '@polkadot/extension-dapp'
 
function usePolkadotWallet() {
  const [accounts, setAccounts] = useState([])
  const [isConnected, setIsConnected] = useState(false)
 
  const connect = async () => {
    const extensions = await web3Enable('My dApp')
    if (extensions.length > 0) {
      const allAccounts = await web3Accounts()
      setAccounts(allAccounts)
      setIsConnected(true)
    }
  }
 
  return { accounts, isConnected, connect }
}
最后更新于
API 参考快速开始