ARK Connect is a browser extension for Chrome and Firefox that offers message and transaction signing. ARK Connect allows users to log in, approve actions and interact with the ARK Ecosystem.
- wxt
- vite
- webextension-polyfill
- formik
- Redux Toolkit
- ArdentHQ Platform SDK
- ESLint
- Styled components
- Styled system
- Clone this repository with
git clone git@github.com:ArdentHQ/arkconnect-extension.git - Setup your
.envby runningcp .env.example .envand adjusting it to your needs - Install dependencies with
pnpm i - Run the application with
pnpm dev
Building results in a browser-specific build. There are two commands that exists to achieve this:
pnpm build:chrome
pnpm build:firefoxPick the one applicable for your environment and it will generate a build in dist/chrome-mv3/ or dist/firefox-mv2/.
- When the build completes, open Chrome or Edge and navigate to
chrome://extensions. Make sure to turn on the developer mode switch. - Click on the "Load unpacked extension" button
- Select the
dist/chrome-mv3folder in this project (afterpnpm devorpnpm build:chrome)
- When the build completes, open Firefox and navigate to
about:debugging. - Click on the "This Firefox" button
- Click on "Load temporary add-on"
- Select the
manifest.jsonfile insidedist/firefox-mv2/
For usage on a website, please refer to the dedicated Documentation file
Builds are generated automatically by the GitHub workflows on the develop and main branches. These can be used to upload to the web extension stores.
For bumping the version number, update package.json with npm version <major|minor|patch> --no-git-tag-version or by manually incrementing the number
This section will highlight common issues and their solutions
pnpm dev runs wxt's dev mode and auto-loads the extension in a fresh browser profile with hot reload. If launching a custom browser binary or starting URL is needed, set VITE_FIREFOX_BINARY and/or VITE_START_URL in .env.