README.md

xverse-extension

Installing and Running

Procedures

1. Check if your Node.js version is >= 14.
2. Clone this repository.
3. Make sure you're logged in to the @secretkeylabs scope on the GitHub NPM package registry. See the Guide
   1. Create a GitHub personal access token (classic)
   2. Run npm login --scope=@secretkeylabs --registry=https://npm.pkg.github.com
   3. Username: GITHUB USERNAME Password: PERSONAL_ACCESS_TOKEN Email: PUBLIC-EMAIL-ADDRESS
4. Add .env file (example: .env.example)
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.

Developing with local dependencies

Use esm build, and reference your filesystem in package.json

For example, if your xverse-core and xverse-web-extension are in same directory, make or pull your local changes to xverse-core, then:

cd ../xverse-core && npm i && npm run build:esm && \
cd $OLDPWD && npm i --legacy-peer-deps @secretkeylabs/xverse-core@../xverse-core && npm start

Run E2E Tests

Our End-to-end (E2E) test suite is build with Playwright. To run the whole E2E test suite, run:

npm run e2etest

If you only want to run the smoke test suite, run

npm run e2etest:smoketest

If you want to run the e2e test in UI Mode:

npm run e2etest:ui

To generate test report, run:

npm run e2etest:report