Go to file
2023-04-26 14:54:07 -03:00
.vscode wallet-core: only allow enabling dev mode via separate request 2022-10-13 15:24:47 +02:00
build-system build-system: bump required node version to v18 2023-02-03 16:10:16 +01:00
contrib add bill of materials to prebuilt 2023-04-24 11:57:20 -03:00
packages add version text 2023-04-26 14:54:07 -03:00
vendor@38acabfa60 vendor submodule 2022-01-05 14:32:21 +01:00
.dir-locals.el Add a .dir-locals,el for configuring emacs for this project 2019-03-15 21:44:02 +01:00
.eslintrc.js using namespaces for good 2022-05-18 11:04:45 -03:00
.gitattributes don't distribute ./bootstrap 2020-11-13 22:32:49 +01:00
.gitignore build system: makefile for taler-wallet-cli 2022-10-28 14:58:08 +02:00
.gitlab-ci.yml missing npm install for workaround 2021-04-15 10:26:05 -03:00
.gitmodules update URL of submodule ‘build-scripts’ 2022-01-27 04:40:07 -05:00
.prettierrc add config for code formatter (prettier) 2019-06-26 15:29:59 +02:00
AUTHORS authors file 2016-02-29 18:04:08 +01:00
bootstrap Fix build. 2023-01-05 22:44:01 +01:00
CHANGELOG.md changelog 2020-11-17 18:04:25 +01:00
COPYING add license 2016-03-15 20:12:35 +01:00
INSTALL install file 2016-03-18 15:50:24 +01:00
Makefile repo: move Makefile helper scripts to contrib 2023-03-29 19:33:58 +02:00
package.json running all tests in sequential mode, otherwise it will fail (maybe ava can't run in parallel?) 2023-04-21 09:32:44 -03:00
pnpm-lock.yaml using build from web-utils 2023-04-24 11:57:19 -03:00
pnpm-workspace.yaml modularize repo, use pnpm, improve typechecking 2020-08-03 13:01:05 +05:30
README -typo 2022-11-21 14:49:15 +01:00
tsconfig.build.json bump version 2021-12-16 14:10:12 +01:00

# GNU Taler Wallet & Anastasis Web UI

This repository contains the implementation of a wallet for GNU Taler written
in TypeScript and Anastasis Web UI

## Dependencies

The following dependencies are required to build the wallet:

- python>=3.8
- nodejs>=12
- jq
- npm
- pnpm
- zip

## Installation

The CLI version of the wallet supports the normal GNU installation process.

```shell
./configure [ --prefix=$PREFIX ] && make install
```

### Compiling from Git

If you are compiling the code from git, you have to run `./bootstrap` before
running `./configure`.

### Building the WebExtension

The WebExtension can be built via the 'webextension' make target:

```shell
./configure && make webextension
```

This will create the zip file with the WebExtension in the directory

```
packages/taler-wallet-webextension/extension/
```

### Installing local WebExtension

Firefox:
 - Settings
 - Add-ons
 - Manage your extension -> Debug Add-ons
 - Load temporary Add-on...
 - Look for the zip file under './packages/taler-wallet-webextension/extension/' folder

Chrome:
 - Settings
 - More tools
 - Extensions
 - Load unpacked
 - Look for the folder under './packages/taler-wallet-webextension/extension/'

You may need to use manifest v2 or v3 depending on the browser version:
https://blog.mozilla.org/addons/2022/05/18/manifest-v3-in-firefox-recap-next-steps/
https://developer.chrome.com/docs/extensions/mv3/mv2-sunset/

### Reviewing WebExtension UI examples

The WebExtension can be tested using example stories.
To run a live server use the 'dev-view' target

```shell
make webextension-dev-view
```

Stories are defined with a \*.stories.tsx file [1], you are free to create new or edit
some and commit them in order to create a more complete set of examples.

[1] look for them at packages/taler-wallet-webextension/src/\*_/_.stories.tsx

### WebExtension UI Components

Every group of component have a directory and a README.
Testing component is based in two main category:

- UI testing
- State transition testing

For UI testing, every story example will be taken as a unit test.
For State testing, every stateful component should have an `useStateComponent` function that will be tested in a \*.test.ts file.

### Testing WebExtension

After building the WebExtension look for the folder `extension`
Inside you will find v2 and v3 version referring to the manifest version being used.

Firefox users:

- Go to about:addons
- Then `debug addon` (or about:debugging#/runtime/this-firefox)
- Then `Load temporary addon...`
- Select the `taler-wallet-webextension-*.zip`

Chrome users:

- Settings -> More tools -> Extensions (or go to chrome://extensions/)
- `Load unpacked` button in the upper left
- Selected the `unpacked` folder in v2 or v3

# Integration Tests

This repository comes with integration tests for GNU Taler. To run them,
install the wallet first. Then use the test runner from the
taler-integrationtests package:

```shell
# List available tests
taler-wallet-cli testing list-integrationtests

# Run all tests
taler-wallet-cli testing run-integrationtests 

# Run all tests matching pattern
taler-wallet-cli testing run-integrationtests $GLOB

$ Run all tests from a suite
taler-wallet-cli testing run-integrationtests --suites=wallet
```

The test runner accepts a bash glob pattern as parameter. Individual tests can
be run by specifying their name.

To check coverage, use nyc from the root of the repository and make sure that the taler-wallet-cli
from the source tree is executed, and not the globally installed one:

```
nyc ./packages/taler-wallet-cli/bin/taler-wallet-cli '*'
```

## Minimum required browser for WebEx

Can be found in: 
 - packages/taler-wallet-webextension/manifest-v2.json
 - packages/taler-wallet-webextension/manifest-v3.json

## Anastasis Web UI

## Building for deploy

To build the Anastasis SPA run:

```shell
make anastasis-webui
```

It will run the test suite and put everything into the dist folder under the project root (packages/anastasis-webui).
You can run the SPA directly using the file:// protocol.

```shell
firefox packages/anastasis-webui/dist/ui.html
```

Additionally you can create a zip file with the content to upload into a web server:

```shell
make anastasis-webui-dist
```

It creates the zip file named `anastasis-webui.zip`