
Product
Introducing Repository Labels and Security Policies
Socket is introducing a new way to organize repositories and apply repository-specific security policies.
eth-keyring-controller
Advanced tools
A module for managing various keyrings of Ethereum accounts, encrypting them, and using them.
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:
yarn add eth-keyring-controller
This library uses the Node.js events
API. If you are using this library outside of a Node.js context, ensure that you have a polyfill for the events
API (this is built-in to browserify
).
const KeyringController = require('eth-keyring-controller');
const SimpleKeyring = require('@metamask/eth-simple-keyring');
const keyringController = new KeyringController({
keyringTypes: [SimpleKeyring], // optional array of types to support.
initState: initState.KeyringController, // Last emitted persisted state.
encryptor: {
// An optional object for defining encryption schemes:
// Defaults to Browser-native SubtleCrypto.
encrypt(password, object) {
return new Promise('encrypted!');
},
decrypt(password, encryptedString) {
return new Promise({ foo: 'bar' });
},
},
});
// The KeyringController is also an event emitter:
this.keyringController.on('newAccount', (address) => {
console.log(`New account created: ${address}`);
});
this.keyringController.on('removedAccount', handleThat);
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.
nvm use
will automatically choose the right node version for you.yarn install
to install dependencies and run any required post-install scriptsRun yarn test
to run the tests once.
Run yarn lint
to run the linter, or run yarn lint:fix
to run the linter and fix any automatically fixable issues.
The project follows the same release process as the other libraries in the MetaMask organization. The GitHub Actions action-create-release-pr
and action-publish-release
are used to automate the release process; see those repositories for more information about how they work.
Choose a release version.
If this release is backporting changes onto a previous release, then ensure there is a major version branch for that version (e.g. 1.x
for a v1
backport release).
v1.0.2
release, you'd want to ensure there was a 1.x
branch that was set to the v1.0.1
tag.Trigger the workflow_dispatch
event manually for the Create Release Pull Request
action to create the release PR.
action-create-release-pr
workflow to create the release PR.Update the changelog to move each change entry into the appropriate change category (See here for the full list of change categories, and the correct ordering), and edit them to be more easily understood by users of the package.
yarn auto-changelog validate --rc
to check that the changelog is correctly formatted.Review and QA the release.
Squash & Merge the release.
action-publish-release
workflow to tag the final release commit and publish the release on GitHub.Publish the release on npm.
publish-release
GitHub Action workflow to finish. This should trigger a second job (publish-npm
), which will wait for a run approval by the npm publishers
team.publish-npm
job (or ask somebody on the npm publishers team to approve it for you).publish-npm
job has finished, check npm to verify that it has been published.[9.0.0] [DEPRECATED]
init
method (#163).
init
method, it will be called automatically upon construction. It is called with await
, so it can be asynchronous.keyringTypes
with keyringBuilders
(#163).
type
string property set to the keyring type name. See the newly exported keyringBuilderFactory
function for an example. The builder functions must be synchronous; use an init
method for asynchronous initialization steps.KeyringController
is now a named export instead of a default export (#163).@metamask/eth-simple-keyring
from v4 to v5 (#171).
@metamask/eth-simple-keyring
release notes for details on required changes.getKeyringClassForType
method with getKeyringBuilderForType
(#163).@metamask/eth-hd-keyring
to v5 (#177)
@metamask/eth-hd-keyring
release notes for details on required changes.@metamask/eth-sig-util
to v5 (#180)@metamask/browser-passworder
from v4.0.1 to v4.0.2 (#182)bip39
dependency (#179)addAccounts
HD Keyring method (#176)
FAQs
A module for managing various keyrings of Ethereum accounts, encrypting them, and using them.
The npm package eth-keyring-controller receives a total of 1,274 weekly downloads. As such, eth-keyring-controller popularity was classified as popular.
We found that eth-keyring-controller demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket is introducing a new way to organize repositories and apply repository-specific security policies.
Research
Security News
Socket researchers uncovered malicious npm and PyPI packages that steal crypto wallet credentials using Google Analytics and Telegram for exfiltration.
Product
Socket now supports .NET, bringing supply chain security and SBOM accuracy to NuGet and MSBuild-powered C# projects.