Go to file
2021-07-09 13:51:33 +02:00
.vscode fix issues with circular imports 2021-06-02 13:56:29 +02:00
build-system add frozen lockfile 2021-05-24 19:26:27 -03:00
contrib another typo 2021-04-28 00:15:19 +02:00
packages env var name 2021-07-09 13:51:33 +02: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 migrate to preact 2021-05-07 10:39:49 -03:00
.gitattributes don't distribute ./bootstrap 2020-11-13 22:32:49 +01:00
.gitignore docker-based build instructions 2020-11-25 16:30:31 +01:00
.gitlab-ci.yml missing npm install for workaround 2021-04-15 10:26:05 -03:00
.gitmodules remove defunct campt-samples for now 2021-05-17 12:58:36 +02: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 remove configure first 2020-11-04 12:11:04 +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
package.json towards wallet-core / util split 2021-03-17 17:56:37 +01:00
pnpm-lock.yaml change taler-wallet-android to taler-wallet-embedded 2021-07-07 02:42:55 -04:00
pnpm-workspace.yaml modularize repo, use pnpm, improve typechecking 2020-08-03 13:01:05 +05:30
README add instructions on ‘docker’ group prior to original Docker instructions 2020-12-04 10:47:09 -05:00
tsconfig.build.json fix build issues 2021-03-27 14:36:08 +01:00

# GNU Taler Wallet

This repository contains the implementation of a wallet for GNU Taler written
in TypeScript.


## 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
```

### 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/
```

We also provide a `Dockerfile` for a container that can build the
WebExtension.  After you install docker, make sure the user is in group
`docker` and (re-)start the docker daemon:

```shell
# Make sure there is a docker group.
$ grep docker: /etc/group
$ sudo groupadd docker

# Make sure USER is defined and is in the docker group.
$ echo $USER
$ sudo usermod -aG docker $USER

# Restart the docker daemon.
# (This command is OS-specific.)

# Obtain a new shell.  Make sure it includes the `docker` group.
$ newgrp docker
$ id
```

Then, you can proceed with these instructions:

```shell
# Download wallet source code and unpack it
(host)$ tar -xf wallet-core-$version.tar.gz

# Build the image
(host)$ docker build --tag walletbuilder wallet-core-$version/contrib/wallet-docker

# Start the container
(host)$ docker run -dti --name walletcontainer walletbuilder /bin/bash

# Copy wallet source to container
(host)$ docker cp ./wallet-core-$version/ walletcontainer:/

# Attach to container
(host)$ docker attach walletcontainer

# Run build inside container
(container)$ cd wallet-core-$version
(container)$ ./configure && make webextension
(container)$ exit

# Copy build artefact(s) to host
(host)$ docker cp walletcontainer:/wallet-core-$version/packages/taler-wallet-webextension/extension extension
```


### Compiling from Git

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


# 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
cd packages/taler-integrationtests/
./testrunner '*'
```

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:

```
PATH="$PWD/packages/taler-wallet-cli/bin:$PATH" \
  nyc ./packages/taler-integrationtests/testrunner '*'
```