@aioha/aioha
v1.5.5
Published
All-In-One Hive Authentication API
Downloads
42
Maintainers
Readme
Aioha
Aioha is an API that provides a common interface for working with different Hive login providers. This allows easier integration of Hive login and transacting on the network with fewer code.
This repository contains the core API designed for use in browser contexts. Ready to use packages with UI included are to follow soon.
Supported Providers
Installation
pnpm i @aioha/aioha
Usage Example
import { initAioha, Asset, KeyTypes, Providers } from '@aioha/aioha'
// Instantiation
const aioha = initAioha({
hiveauth: {
name: 'Aioha',
description: 'Aioha test app'
},
hivesigner: {
app: 'ipfsuploader.app',
callbackURL: window.location.origin + '/hivesigner.html',
scope: ['login', 'vote']
}
})
// Get registered providers
console.log(aioha.getProviders())
// Get current logged in user and provider name
if (aioha.isLoggedIn()) {
console.log(aioha.getCurrentUser(), aioha.getCurrentProvider())
}
// Login with provider. Supported providers are listed above, as in Providers enum.
const login = await aioha.login(Providers.Keychain, 'hiveusername', {
msg: 'Hello World',
keyType: KeyTypes.Posting,
hiveauth: {
cbWait: (payload, evt) => {
// display HiveAuth QR code using `payload` as data
}
}
})
// Transfer 1 HIVE using logged in provider
const xfer = await aioha.transfer('recipient', 1, Asset.HIVE, 'Transferred using Aioha with memo')
// Vote comment with 100% weight
const vote = await aioha.vote('author', 'permlink', 10000)
// Claim rewards
const rewardClaim = await aioha.claimRewards()
More usage details can be found on the Aioha documentation here.
Local storage reserved keys
Aioha uses certain keys in browser localStorage
to store persistent logins, and in the case of HiveSigner provider, pass info from callback URL.
The following keys are reserved:
- General:
aiohaUsername
,aiohaProvider
- HiveAuth:
hiveauthToken
,hiveauthKey
,hiveauthExp
- HiveSigner:
hivesignerTxId
,hivesignerToken
,hivesignerExpiry
,hivesignerUsername
- Ledger:
ledgerPath
HiveSigner callback page
A callback page is required for HiveSigner provider. An example HTML with the code which parses the response data and stores them into localStorage
has been included in snippets/hivesigner.html
file.
Build
pnpm run build
pnpm run webpack
tsc
output can be found in build
folder and the Webpack output can be found in dist
folder with bundle.js
being the entrypoint. All Webpack output files are to be served and will be loaded on-demand depending on the provider selected upon login.