Eth Keyring Controller
A module for managing groups of Ethereum accounts called "Keyrings", defined originally for MetaMask's multiple-account-type feature.
To add new account types to a KeyringController
, just make sure it follows The Keyring Class Protocol.
The KeyringController has three main responsibilities:
- Initializing & using (signing with) groups of Ethereum accounts ("keyrings").
- Keeping track of local nicknames for those individual accounts.
- Providing password-encryption persisting & restoring of secret information.
Installation
npm install bch-keyring-controller --save
Usage
const KeyringController = const SimpleKeyring = const keyringController = keyringTypes: SimpleKeyring // optional array of types to support. initState: initStateKeyringController // Last emitted persisted state. encryptor: // An optional object for defining encryption schemes: // Defaults to Browser-native SubtleCrypto. { return 'encrypted!' } { return foo: 'bar' } // The KeyringController is also an event emitter:thiskeyringControllerthiskeyringController
Methods
Currently the methods are heavily commented in the source code, so it's the best place to look until we aggregate it here as well.