Skip to main content

Custom Provider

Besides the built-in providers, a custom defined provider that extends AiohaBaseProvider class may be registered as Providers.Custom provider. This may be useful for backend use or development of another browser provider.

Beekeeper Signer​

The recommended signer for backend usage is the BeekeeperProvider, which delegates key storage and signing to a Beekeeper wallet. Private keys never leave the wallet — the provider only holds public keys and passes digests to the wallet for signing.

Installation​

pnpm i @aioha/aioha @hiveio/beekeeper

Usage​

import { Aioha, AiohaClient, Providers, KeyTypes } from '@aioha/aioha'
import { BeekeeperProvider } from '@aioha/aioha/build/providers/custom/beekeeper.js'
import { SimpleEventEmitter } from '@aioha/aioha/build/lib/event-emitter.js'
import createBeekeeper from '@hiveio/beekeeper'

// Initialize a beekeeper wallet and import the private key
const bk = await createBeekeeper({ inMemory: true })
const session = bk.createSession('some-salt')
const { wallet } = await session.createWallet('my-wallet', 'password', true)
const pubKey = await wallet.importKey('5somethingsomething')

// Register the beekeeper provider with Aioha
const aioha = new Aioha()
aioha.registerCustomProvider(
  new BeekeeperProvider(
    wallet,
    { [KeyTypes.Posting]: pubKey, [KeyTypes.Active]: pubKey },
    new AiohaClient(),
    new SimpleEventEmitter()
  )
)

// Login as usual
const login = await aioha.login(Providers.Custom, 'your-username', { msg: 'Hello World' })

// Claim rewards
const claim = await aioha.claimRewards()
console.log(claim)

The keys map associates a KeyTypes entry (Posting, Active, Owner, Memo) with the public key of the corresponding private key held in the wallet. Only key types present in the map can sign — attempting to use a missing key type throws.

Custom SHA-256 implementation

The constructor accepts an optional fifth argument to supply your own SHA-256 function (e.g. sha256 from @noble/hashes). If omitted, the browser-compatible default from Aioha is used.

Persistent wallets

Use inMemory: true for ephemeral sessions only. For persistent storage, omit the flag and supply storageRoot — see the Beekeeper docs for configuration.

Plaintext Private Key​

Deprecated

PlaintextKeyProvider is deprecated in favor of the Beekeeper signer. It holds the WIF in memory and should not be used in new code.

import { Aioha, Providers } from '@aioha/aioha'
import { PlaintextKeyProvider } from '@aioha/aioha/build/providers/custom/plaintext.js'

const aioha = new Aioha()
aioha.registerCustomProvider(new PlaintextKeyProvider('5somethingsomething'))

const login = await aioha.login(Providers.Custom, 'your-username', { msg: 'Hello World' })