Git Product home page Git Product logo

recovery-rluggins's Introduction

Sample Burner Wallet 2 Plugin

This repo provides a boilerplate for building a new plugin for the Burner Wallet 2.

Setup

  1. Clone the repo
  2. Run yarn install. This repo uses Lerna and Yarn Workspaces, so yarn install will install all dependencies and link modules in the repo
  3. To connect to mainnet & most testnets, you'll need to provide an Infura key. Create a file named .env in the basic-wallet folder and set the contents to REACT_APP_INFURA_KEY=<your key from infura.com>
  4. Run yarn start-local to start the wallet while connected to Ganache, or run yarn start-basic to start the wallet connected to Mainnet & xDai

Renaming the plugin

To rename the plugin from "MyPlugin" to your own plugin name, you must update the following locations:

  1. Rename the my-plugin directory
  2. Change my-plugin in lerna.json and the root package.json
  3. Change the name field in package.json in your plugin's package.json file
  4. Rename MyPlugin.ts
  5. Change MyPlugin.js and MyPlugin.d.ts in the plugin package.json file
  6. Change the class name in the main plugin file
  7. Change rename my-plugin dependency in basic-wallet/package.json & local-wallet/package.json
  8. In basic-wallet/src/index.tsx and local-wallet/src/index.tsx, update the import import MyPlugin from 'my-plugin'; as well as the new MyPlugin() constructor.
  9. Finally, run yarn install in the root to re-link the packages

recovery-rluggins's People

Contributors

dmihal avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.