https://github.com/dmihal/xdai.io

https://github.com/dmihal/xdai.io

Last synced: 23 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dmihal/xdai.io
• Owner: dmihal
• Created: 2020-03-25T01:09:49.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-26T19:22:38.000Z (almost 2 years ago)
• Last Synced: 2024-10-04T10:40:43.266Z (about 1 month ago)
• Language: TypeScript
• Size: 6.5 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 23
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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=`

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