@polkadot/ui-keyring

A wrapper extending the base @polkadot/keyring interface for usage in the browser:
Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.

Usage Examples

All module methods are exposed through a single default export.

$3

``js
import keyring from @polkadot/ui-keyring

render () {
// encode publicKey to ss58 address
const address = keyring.encodeAddress(publicKey);

// get keyring pair from ss58 address
const pair = keyring.getPair(address);

// ask questions about that particular keyring pair
const isLocked = pair.isLocked;
const meta = pair.meta;

// save account from pair
keyring.saveAccount(pair, password);

// save address without unlocking it
keyring.saveAddress(address, { ...meta });
}
`

Observables

Option 1: Declarative subscribe/unsubscribe w/ react-with-observable (recommended 'React' way)

`js
import accountObservable from '@polkadot/ui-keyring/observable/accounts';
import { SingleAddress, SubjectInfo } from '@polkadot/ui-keyring/observable/types';
import React from 'react';
import { Subscribe } from 'react-with-observable';
import { map } from 'rxjs';

class MyReactComponent extends React.PureComponent {
render () {

{accountObservable.subject.pipe(
map((allAccounts: SubjectInfo) =>
!allAccounts
? this.renderEmpty()
: Object.values(allAccounts).map((account: SingleAddress) =>
// Your component goes here
console.log(account.json.address)
)
))}

}

renderEmpty () {
return (


);
}
}

`

Option 2: Imperative subscribe/unsubscribe

`js
import accountObservable from '@polkadot/ui-keyring/observable/accounts';
import { SingleAddress, SubjectInfo } from '@polkadot/ui-keyring/observable/types';
import React from 'react';
import { Subscription } from 'rxjs';

type State = {
allAccounts?: SubjectInfo,
subscriptions?: [Subscription]
}

class MyReactComponent extends React.PureComponent {
componentDidMount () {
const accountSubscription = accountObservable.subject.subscribe((observedAccounts) => {
this.setState({
accounts: observedAccounts
});
})

this.setState({
subscriptions: [accountSubscription]
});
}

componentWillUnmount () {
const { subscriptions } = this.state;

for (s in subscriptions) {
s.subject.unsubscribe();
}
}

render () {
const { accounts } = this.state;

return (


All Accounts

{
Object.keys(accounts).map((address: SingleAddress) => {
return

{address}

;
})
}
)
}
}
`

FAQ

- Difference between Keyring Accounts and Addresses?
- From the perspective of the keyring, it saves a particular user's unlocked identities as an account, a la keyring.saveAccount(pair, password). So with these accounts you are able to send and sign transactions.
- To save addresses without unlocking them (i.e. because a user might want to have easy access to addresses they frequently transact with), use keyring.saveAddress(address, meta)
- What are 'external' accounts, i.e. when to set the isExternal` meta key to true?
- An external account is one where the keys are not managed by keyring, e.g. in Parity Signer or Ledger Nano.
- SS58 Encode / Decode?
- SS58 is a simple address format designed for Substrate based chains. You can read about its specification in more detail in the Substrate Documentation.

If you have any unanswered/undocumented questions, please raise an issue here.

Users

Keyring is core to many polkadot/substrate apps.

* polkadot-js/apps
* paritytech/substrate-light-ui