Announcements

Features

• Multilanguages Supports (Done)
• Sentry Support (On Planning)
• Genache Server & Cli Support (On Planning)
• Account Controller (on Developing)
  • Mnemonic seed generate for account creation process
  • Derived Private key from Mnemonic
  • Derived Public key from Private key
  • Brain key input and recommendation used as password to unlock wallet and hash private data
  • Vault storage and hashing private account information like 'private key' to blob-store
  • Account link with 3box id (optionals)
• Network Controller (on Planning- Jan/2022)
• Transaction Controller (on Planning - Feb/2022)
• Hardware Wallet Connect (on Planning - Feb/2022)
• ...

Installing and Running

Procedures:

1. Check if your Node.js version is >= 14.
2. Clone this repository.
3. Change the package's name, description, and repository fields in package.json.
4. Change the name of your extension on src/manifest.json.
5. Run npm install to install the dependencies.
6. Run npm start
7. Load your extension on Chrome following:
   1. Access chrome://extensions/
   2. Check Developer mode
   3. Click on Load unpacked extension
   4. Select the build folder.
8. Happy hacking.

Structure

All your extension's code must be placed in the src folder.

TypeScript

Supports TypeScript! The Options Page is implemented using TypeScript. Please refer to src/pages/Options/ for example usages.

Webpack auto-reload and HRM

To make your workflow much more efficient this boilerplate uses the webpack server to development (started with npm start) with auto reload feature that reloads the browser automatically every time that you save some file in your editor.

You can run the dev mode on other port if you want. Just specify the env var port like this:

$ PORT=6002 npm run start

Content Scripts

Although uses the webpack dev server, it's also prepared to write all your bundles files on the disk at every code change, so you can point, on your extension manifest, to your bundles that you want to use as content scripts, but you need to exclude these entry points from hot reloading (why?). To do so you need to expose which entry points are content scripts on the webpack.config.js using the chromeExtensionBoilerplate -> notHotReload config. Look the example below.

Let's say that you want use the myContentScript entry point as content script, so on your webpack.config.js you will configure the entry point and exclude it from hot reloading, like this:

{
  …
  entry: {
    myContentScript: "./src/js/myContentScript.js"
  },
  chromeExtensionBoilerplate: {
    notHotReload: ["myContentScript"]
  }
  …
}

and on your src/manifest.json:

{
  "content_scripts": [
    {
      "matches": ["https://www.google.com/*"],
      "js": ["myContentScript.bundle.js"]
    }
  ]
}

Packing

After the development of your extension run the command

$ NODE_ENV=production npm run build

Now, the content of build folder will be the extension ready to be submitted to the Chrome Web Store. Just take a look at the official guide to more infos about publishing.

Secrets

If you are developing an extension that talks with some API you probably are using different keys for testing and production. Is a good practice you not commit your secret keys and expose to anyone that have access to the repository.

To this task this boilerplate import the file ./secrets.<THE-NODE_ENV>.js on your modules through the module named as secrets, so you can do things like this:

./secrets.development.js

export default { key: '123' };

./src/popup.js

import secrets from 'secrets';
ApiCall({ key: secrets.key });

👉 The files with name secrets.*.js already are ignored on the repository.

Resources:

DEVELOPMENTS

• Webpack documentation
• Chrome Extension documentation
• A glossary of common terms in ethereum crypto space

PROTOCOLS

• JSON-RPC Method
• Ethereum js provider specfified in EIP-1193
• Ethereum Web3 wallet permission in EIP-2255
• Ethereum typed structured data hashing and signing

MNEMONIC PHRASES

• MNEMONIC PHRASE/SEED PHRASE/BIP39
• BIP39 WORDLIST
• SLIP39 PROPOSALS
• EIP-3450 LIKE BIP39 BUT ON ETHEREUM
• EIP-3450 WORDLIST

PACKAGES

• JSON RPC Capabilities Middleware, compatible with EIP-2255
• JavaScript implementations - Signing Data
• Decentrailized storage, messsage solution for Dapps
• Ceramic - Decentrailized flatform for create, host , share stream of data

EXAMPLES

• JS Ethereum Signature Example - Signing Data

---

save orange bacon jaguar mobile poet bar between clog coral banana useful