Developer Documentation

The GeroWallet browser extension is public. Read it, build it, and contribute.

Build from source

Requires Node.js 18 or newer, npm, Git, and a Chromium based browser.

git clone https://github.com/Gero-Labs/gerowallet.git
cd gerowallet
npm install
cp .env.example .env.development
npm run dev

Then load it in your browser:

1Open chrome://extensions/
2Enable Developer mode
3Click Load unpacked
4Select the extension/ folder

For a production build, run npm run build.

Configuration

.env.example documents every environment variable. Third party integrations such as fiat on-ramps need your own keys; the repository ships placeholders only. Core wallet functionality does not require them.

On verification

Building from source gives you a build you control. It does not currently produce a byte for byte match with the Chrome Web Store release, as reproducible builds are not yet in place.

How the code is organized

Path	Contents
src/chrome/	Background service worker, messaging, key operations, signing
src/modules/	Feature modules such as dashboard, staking, governance, and swap
src/stores/	Application state
src/services/	Business logic, sync, and wallet management
src/db/	Local IndexedDB layer
src/api/	Backend and data provider clients
src/shared/	Shared utilities, composables, and transaction building

A deeper walkthrough of the system design lives in ARCHITECTURE.md.

Contributing

Send a change

Read CONTRIBUTING.md
Search existing issues
Fork, branch from development, and open a pull request

We use Conventional Commits. Run npm run typecheck and npm run lint before submitting.

Reporting a vulnerability

Please do not open a public issue for security problems.

Follow the disclosure process in SECURITY.md. Private vulnerability reporting is enabled on the repository.

Contributors are expected to follow our Code of Conduct. Issues are labelled, and good first issue is a reasonable place to start.

License

GeroWallet is published under the Apache License 2.0 (Copyright A.D. Labs), an OSI-approved permissive open source licence.

You may

Read, audit, and inspect all of the code
Fork and modify it
Build and run your own version
Use it commercially
Distribute and sublicense it
Contribute changes back to the repository

Apache 2.0 asks that you retain the copyright and licence notices, state any significant changes you make, and include a copy of the licence with any distribution. It also grants an express patent licence. It does not grant trademark rights, so the GeroWallet name and logo remain ours.

Read the full license text and the NOTICE file.