Skip to content
CoNET-projectPublic

About

Shared consumer PWA interface for Beamio browser, iOS and Android applications.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

beamio-UI

The consumer web application of Beamio: a React and TypeScript progressive web app (PWA). The same UI is embedded in the Beamio iOS and Android shells as their shared user interface.

What this repository is, and is not

This repository contains the consumer PWA and the UI that the iOS and Android shells load. It does not contain:

  • Beamio POS (the merchant point-of-sale terminal),
  • Beamio Merchant OS (the merchant operations console),
  • the native shell projects for iOS and Android,
  • backend services, operator tooling, or smart contracts.

Those components live in other places and have their own release processes. A change in this repository does not by itself replace a native SDK or a store binary.

Features

These features exist in the source tree. Availability depends on the deployed version, the native bridge, and the service configuration.

  • Wallet access: creation, recovery, and account management flows.
  • Payments in USDC and merchant-issued store credit (shown as Service Credits), including balance views.
  • Merchant discovery, memberships, vouchers, and rewards pages.
  • Messaging through the CoNET Chat SDK (vendored in vendor/conet-chat-sdk), with OpenPGP-based message handling.
  • Voice call screens and call signalling through the CoNET Chat transport.

CoNET Chat does not use WebRTC. Call media and signalling go through the CoNET Chat transport. This repository contains no WebRTC code.

Architecture

  • React 18 with TypeScript, built with Create React App and CRACO (craco.config.js).
  • Ethers v6 for blockchain reads and signing flows.
  • IndexedDB and PouchDB for local persistence.
  • Web workers for background tasks (src/workers/).
  • OpenPGP 6 for message encryption and key handling.
  • The CoNET Chat SDK as a local package (file:./vendor/conet-chat-sdk).

In the browser the app runs as a normal PWA. Inside a native shell, the same bundle runs in a WebView and reaches native features through a bridge. Storage and bridge boundaries differ between the two runtimes. A storage or network failure must stay distinguishable from a confirmed empty account.

Requirements

  • Node.js: the checks in this README were run with Node.js 22.23.3 (npm 10.9.9), which is inside the engines range >=18 <24 in package.json. Use that version. .nvmrc names 20, which has not been verified for this repository.
  • npm with package-lock.json (the lockfile for the commands below).
  • yarn.lock is also present, because package.json declares packageManager: [email protected]. The yarn route has not been verified; use npm.
  • The lockfile resolves 1,455 packages through registry.npmmirror.com, a public npm mirror, and 312 packages through registry.npmjs.org. The lockfile is kept as it was in the source revision.

Install and run

git clone https://github.com/CoNET-project/beamio-UI.git
cd beamio-UI
nvm install 22.23.3           # the version used for the verified checks (requires nvm)
nvm use 22.23.3
npm ci --legacy-peer-deps
npm start                     # development server

npm ci without --legacy-peer-deps stops with ERESOLVE: the peer range of @craco/[email protected] does not accept the locked [email protected]. The lockfile installs cleanly with the flag.

The CoNET Chat SDK is a local dependency (file:./vendor/conet-chat-sdk). Its build output in vendor/conet-chat-sdk/dist is not stored in this repository. npm ci builds it through the SDK's prepare script.

Local development needs no production secrets. Use disposable test accounts, not a personal wallet.

Tests and type check

CI=true npm test -- --watchAll=false
npx tsc --noEmit -p .

In the verified run, 2,029 tests pass and 2 are skipped (2,031 in total) across 234 suites (233 pass, 1 suite skipped). This snapshot omits 28 test files and 11 fixtures (see "Testing: what is not included yet"), so the count is lower than in the internal source revision.

Builds

Command Output Use
npm run build browser build, public path /app web deployment of the PWA
npm run build:shell-embedded embedded build, public path /, shell flag on UI package for an iOS or Android shell
npm run build:shell-qa-embedded embedded build with REACT_APP_PGP_IDENTITY_CREATE_ENABLED=true QA candidate for shells; not a production build

Build output goes to build/. Source maps are generated by default.

Configuration

The build reads these public variables. None is a secret.

Variable Meaning
REACT_APP_SHELL_BUILD true for a shell (embedded) build
REACT_APP_PGP_IDENTITY_CREATE_ENABLED true only for QA builds
PUBLIC_URL public path, set by the build scripts

The repository ships no .env files. Never put secrets in any .env file.

Testing: what is not included yet

This first public snapshot omits some test assets, so its test coverage is lower than that of the internal source revision. The coverage of this repository is not the same as that of the internal monorepo. The omitted assets are:

  • 28 test files, listed in PROVENANCE.md;
  • 11 test-only fixtures under src/services/__fixtures__/, listed in PROVENANCE.md;
  • CoNET Chat SDK assets: vendor/conet-chat-sdk/spec/chat-daemon-vectors.v1.json, vendor/conet-chat-sdk/spec/sendkey-vectors.v1.json, vendor/conet-chat-sdk/spec/chat-daemon-protocol.v1.schema.json, vendor/conet-chat-sdk/scripts/genDaemonVectors.ts, vendor/conet-chat-sdk/scripts/genDaemonSchema.ts, vendor/conet-chat-sdk/scripts/testDaemonConformance.ts and vendor/conet-chat-sdk/scripts/testSendKeyVectors.ts.

Two passcode vector files under src/services/passcode/ are included, because production code imports them. Their metadata strings were edited; their values are unchanged (see PROVENANCE.md).

A follow-up commit will add public, synthetic test vectors for these tests. They will be labelled TEST ONLY, and every derived value will be recomputed.

The repository contains no production credentials. Before publication, a secret scan covered all tracked text files. Contract addresses are public content and are not treated as secrets.

Project layout

public/                  static assets, PWA manifest, service-worker helper pages
src/                     application source
  components/ pages/     UI
  services/              wallet, chat, and bridge logic
  workers/               web workers
  locales/               translations
  utils/ hooks/ config/  helpers
vendor/conet-chat-sdk/   CoNET Chat SDK (MIT)
craco.config.js          build configuration

Release and QA status

This repository publishes the source of a QA candidate. It does not claim production readiness.

Item Status
Source publication Published as a clean snapshot of source revision 91ae47a2 (PWA version 0.53.0). The commit that introduced the snapshot is recorded in PROVENANCE.md.
QA candidate (shell QA) The source is a QA candidate. It is not a production release.
Production acceptance Not accepted. No production device acceptance, web deployment, or store submission has been completed for this version.
Known issue On a device that already holds a native wallet record, a cold start can stay at the entry gate ("Native wallet is not ready"). A fix is planned as the first follow-up commit.

Source publication, QA acceptance, device acceptance, web deployment, and store submission are separate stages. A public commit or a successful build does not establish any of the later stages.

Shell UI package

Each shell embeds exactly one UI ZIP, and the iOS and Android shells must use the same ZIP bytes for a given release:

  1. Build with npm run build:shell-embedded (or the QA variant for QA).
  2. Remove the source map files (*.map) and the trailing sourceMappingURL comment lines from the JavaScript and CSS files before the package is made. The repository does not ship a script for this step.
  3. Record the source commit, the PWA version, and the SHA-256 of the ZIP.
  4. Embed the same file in both shells and verify its SHA-256 in each finished application.

Contributing

Open an issue with the runtime (browser or shell), the application version, the expected and actual behavior, and reproduction steps. Submit focused changes against main, and run the tests and the type check before you open a pull request.

Do not include wallet secrets, recovery codes, test-account credentials, signing keys, or private service configuration in issues, pull requests, or commits. Automated tests must not use real account data, keys, or recovery material.

Source and provenance

This repository was published as a clean snapshot of the reviewed consumer PWA source. Its git history is not included. PROVENANCE.md records the source commit and the file scope.

License

The project's own source code and text are licensed under the MIT License. The full text, with the existing copyright notice, is in MIT_LICENSE. The copyright notice in that file is kept unchanged.

The image files in this repository (PNG, JPEG, WebP, and ICO) are not covered by the MIT License. The project owner confirmed on 2026-11-15 that these images may be published with the source, with their original attribution retained. Any third-party brand marks in them belong to their respective owners and are used under their original terms. The MIT License covers only the project's own source code and text.

Third-party files in this repository keep their own notices:

  • vendor/conet-chat-sdk/ (CoNET Chat SDK): MIT, see vendor/conet-chat-sdk/package.json.
  • public/vendor/ethers/: MIT, see its LICENSE.md.
  • public/pdf.worker.min.js: Apache License 2.0 (Mozilla pdf.js). The licence notice in the file header is kept unchanged.

Dependencies installed from npm are not part of this repository and carry their own licences.

About

Shared consumer PWA interface for Beamio browser, iOS and Android applications.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages