metamask / eth-simple-keyring Goto Github PK

View Code? Open in Web Editor NEW

120.0 120.0 48.0 2.15 MB

A simple standard interface for a series of Ethereum private keys

License: ISC License

JavaScript 17.75% Shell 1.00% TypeScript 81.25%

eth-simple-keyring's Introduction

Built With:

React
Gatsby
❤️ from ConsenSys Digital Experiences Circle

🚀 Quick start

Ask @davidnguyen88 or @jlazoff for config files

Start it up

git clone [email protected]:MetaMask/website.git
yarn
yarn develop

View site

MetaMask is now running at http://localhost:8000!

There is also a GraphQL API at http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

What's where?

Gatsby file structure documentation

.
├── public/
├── src/
    ├── components/
    ├── fonts/
    ├── fragments/
      ├──GraphQL_Documentation.md
    ├── images/
      ├── icons/
      ├── social-icons/
      ├── metamask-logo.svg
      ├── ...
    ├── lib/
      ├── theme.js
    ├── pages/
      ├── index.js
      ├── about.js
      ├── ...
    ├── html.js
├── gatsby-config.js
├── .env
├── GraphQL_Query_Documentation.md
├── package.json
└── README.md

Key Files

gatsby-config.js

The main configuration file for a Gatsby site. This is where you can specify information about your site (metadata), site title ,and description, which Gatsby plugins we are using, etc. (Check out the config docs for more detail).

src/fragments/ GraphQL query fragments that create standard data requests across components

src/lib/theme.js Contains styling constants for font sizes and weights, device sizes for media queries, shadows, and colors.

public/

Automatically generated output of gatsby build process for production.

src/pages

Files within this directory are turned into routes with the name of the file (e.g. about.js becomes /about). Only files within /pages are allowed to make dynamic GraphQL queries which cascade data down to components.

src/html.js Entry file used by Gatsby for all rendered pages html template

eth-simple-keyring's People

Contributors

Stargazers

Watchers

Forkers

ukstv glitch003 mdranger djaramillo021 brunobar79 buypolarbear fiersk17 danjm gudahtt kingdavid6336 botary logvik atulrupnar yqrashawn legoengineering torusresearch kapoio fksyuan isabella232 lao959 smartmetamask karlbenzkarc 0xblockchainx0 terrorizer1980 forkkit caothien96 rabbyhub gnarvaja viralatafinance tmpfs szfdiwang hx8888979 pinkdiamond1 danbamikiya likloadm moha19med88 bestxeosx-gm alissaalissa adeliavale legobeat gindokiw alaban321 syroezhe4ka

eth-simple-keyring's Issues

problem using in react native, regarding dependencies

I have a problem using this package in react native env, with this error message

Unable to resolve module crypto

  71 | Object.defineProperty(exports, "__esModule", { value: true });
  72 | exports.thirdparty = exports.hdkey = void 0;
> 73 | var crypto = __importStar(require("crypto"));
     |                                    ^
  74 | var ethereumjs_util_1 = require("ethereumjs-util");
  75 | var scrypt_js_1 = require("scrypt-js");
  76 | var hdkey_1 = require("./hdkey");

Migrate Incrementally to Typescript

Small packages like this eth-simple-keyring are quite ideal to make the first ts migrations.

EDIT: text moved to main task-issue:

MetaMask/metamask-extension#760

[CI] Tests seem to run only for Committers PR's

Good: #34 #35

Bad: #32 #33

Improve unit test coverage

We should strive for 100% unit test coverage, and to cover all input boundary conditions.

ethereumjs-wallet dependency

we currently use ethereumjs-wallet to:

generate new keys
get address from private key

this is pretty easy to do without this wrapper library and all that it brings with it

Also the current ethereumjs-wallet includes an old version of aes-js which modifies Array.prototype. Latest aes-js does not have this problem.

Migrate to TypeScript

We want to migrate this package to TypeScript to reduce regressions and improve compatibility with our other TypeScript projects.

Remove ethereumjs-wallet dep

Dropping ethereumjs-wallet will remove the scrypt dependency that uses python to try to install some things, making it hard to install on windows 😿

can replace
https://github.com/MetaMask/eth-hd-keyring/blob/d812b9cbecd2a8b56c1edf801438a9c5ae26b922/index.js#L130-L131
with

const HDKey = require('hdkey')
HDKey.fromMasterSeed(seedBuffer).derive(path)

ethereumjs-wallet is just wrapping that
https://github.com/ethereumjs/ethereumjs-wallet/blob/master/hdkey.js#L35-L37

An in-range update of ethereumjs-util is breaking the build 🚨

Version 5.1.3 of ethereumjs-util was just published.

Branch	Build failing 🚨
Dependency	ethereumjs-util
Current Version	5.1.2
Type	dependency

This version is covered by your current version range and after updating it in your project the build failed.

ethereumjs-util is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details

❌ ci/circleci Your tests failed on CircleCI Details

Release Notes

v5.1.3 - Maintenance Release

ES6 syntax updates
Dropped Node 5 support
Moved babel to dev dependencies, switched to env preset
Usage of safe-buffer instead of Node Buffer
Do not allow capital 0X as valid address in isValidAddress()
New methods zeroAddress() and isZeroAddress()
Updated dependencies

Commits

The new version differs by 40 commits.

3e72947 Release commit for v5.1.3
279ac78 Updated deprecated babel es2015 to env preset
3d05254 chore(package): update babelify to version 8.0.0
aed81b9 Merge pull request #106 from ethereumjs/greenkeeper/karma-2.0.0
acc9130 chore(package): update karma to version 2.0.0
a65787d Merge pull request #102 from ethereumjs/greenkeeper/karma-detect-browsers-2.2.6
deb4019 chore(package): update karma-detect-browsers to version 2.2.6
193a119 Merge pull request #98 from ethereumjs/greenkeeper/mocha-4.0.0
f0aafb0 Update travis to build with Node 8 (from Node 7)
5d59ad6 Merge branch 'master' into greenkeeper/mocha-4.0.0
9e6cda9 Merge pull request #96 from ethereumjs/greenkeeper/coveralls-3.0.0
7f31795 Merge branch 'master' into greenkeeper/coveralls-3.0.0
15d4085 Merge pull request #91 from ethereumjs/greenkeeper/documentation-5.2.0
0c0f23f Rebuild docs with new documentation version
d75a4b2 Updated build:docs command to reflect syntax changes from updated documentation version

There are 40 commits in total.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

An in-range update of eth-sig-util is breaking the build 🚨

Version 1.4.1 of eth-sig-util was just published.

Branch	Build failing 🚨
Dependency	eth-sig-util
Current Version	1.4.0
Type	dependency