Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/starcoinorg/starmask-extension
A blockchain wallet browser extension for starcoin
https://github.com/starcoinorg/starmask-extension
Last synced: about 10 hours ago
JSON representation
A blockchain wallet browser extension for starcoin
- Host: GitHub
- URL: https://github.com/starcoinorg/starmask-extension
- Owner: starcoinorg
- License: apache-2.0
- Created: 2021-03-30T02:48:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-16T02:48:16.000Z (about 1 year ago)
- Last Synced: 2024-10-27T08:39:18.959Z (12 days ago)
- Language: JavaScript
- Size: 34.6 MB
- Stars: 35
- Watchers: 20
- Forks: 15
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-move - StarMask - A wallet for the Starcoin blockchain. Maintained by the Starcoin team ([Chrome Webstore](https://chrome.google.com/webstore/detail/starmask/mfhbebgoclkghebffdldpobeajmbecfk?hl=en)). (Wallets / Miscellaneous)
- awesome-aptos - StarMask - A wallet for the Starcoin blockchain. Maintained by the Starcoin team ([Chrome Webstore](https://chrome.google.com/webstore/detail/starmask/mfhbebgoclkghebffdldpobeajmbecfk?hl=en)). (Wallets / Miscellaneous)
- awesome-move - StarMask - A wallet for the Starcoin blockchain. Maintained by the Starcoin team ([Chrome Webstore](https://chrome.google.com/webstore/detail/starmask/mfhbebgoclkghebffdldpobeajmbecfk?hl=en)). (Wallets / Miscellaneous)
- awesome-move - StarMask - A wallet for the Starcoin blockchain. Maintained by the Starcoin team ([Chrome Webstore](https://chrome.google.com/webstore/detail/starmask/mfhbebgoclkghebffdldpobeajmbecfk?hl=en)). (Wallets / Miscellaneous)
README
# StarMask
A blockchain wallet browser extension for Starcoin blockchain.
# Initialize
```
yarn setup
cp .starmaskrc.dist .starmaskrc # change the values according to your needs
yarn start
```
# Development
It is convenient to use `yarn link @starcoin/xxx` for debugging in localhost,
but dont forget doing the following steps before next release:
```
yarn unlink @starcoin/xxx`
yarn add @starcoin/xxx
yarn setup:postinstall
```
# How to transfer the old state in local storage to new state
1. check the last_version_number in `app/scripts/migrations/index.js`
2. NEW_VERSION = last_version_number + 1
3. `yarn generate:migration ` to generate `app/scripts/migrations/.js` and `app/scripts/migrations/.test.js`
4. modify `transformState` in `app/scripts/migrations/.js`, add test cases in `app/scripts/migrations/.test.js`
5. add following line in `app/scripts/migrations/index.js`:
```
require('./').default,
```
6. run `yarn start` or wait until it reloaded, then the old state will be migrated to the new state.
Tips:
1. check `054.js` and `054.test.js` for demo of handling tokens.
2. if you want to debug and re-run .js multi times, you can add following in `app/scripts/background.js` -> loadStateFromPersistence
```
versionedData.meta.version = ;
```
before this line:
```
const { TransactionController } = versionedData.data;
```
# Add build to Chrome
- For security reason, highly reommand add a new profile:
- open Chrome
- At the top right
- click Profile
- Click Add. Choose a name, photo and color scheme.
- Open Settings > Extensions.
- Check "Developer mode".
- Alternatively, use the URL chrome://extensions/ in your address bar
- At the top, click Load Unpacked Extension.
- Navigate to `dist/chrome` folder
- Click Select.
- Change to your locale via chrome://settings/languages
- Restart the browser and test the plugin in your locale
# Publish
- change version in `app/manifest/_base.json`
- `yarn dist`
# How to display custom tokens logo in Main network
1. Maintain custom tokens in [@starcoin/starmask-contract-metadata](https://github.com/starcoinorg/starmask-contract-metadata)
- add token info in `contract-map.json`
- add logo svg/png in folder `images`
- update version in package.json
2. in `starmask-extension`
- update `@starcoin/starmask-contract-metadata` version to the latest one
- copy and paste logo into folder `app/images/contract`
# Docs
- [How to install](./docs/en/how-to-install.md)
- [How to use](./docs/en/how-to-use.md)