Project setup

Pull the docker images:

1. wallet-backend

1. wallet-frontend

Running the project

Wallet-backend

Wallet-frontend

The host configuration can be found in config/web.conf. It describes the host address and port number.

Example Config

webHost = "0.0.0.0"
webPort = 4545

Web-wallet consists of 2 modules (both part of the same repository):

• frontend - customer facing user interface that enables user interaction with wallet's main functions

• backend - providing the required support for frontend, such as:

  • authentication (walletkit)

  • credential-related dependencies (walletkit)

  • token-related dependencies (nftkit)

  • storage (RDBMS)

Get the Project

Make sure you have docker installed on your machine.

git clone https://github.com/walt-id/waltid-identity.git

Launch the Wallet

A docker-compose configuration is provided as a convenience for quick-start. It sets up and starts all modules required to fully benefit from the wallet's functions. The runtime configuration files should be available in the same folder as the docker-compose file. There are sample configuration files provided, except walt.yaml which should be updated with the corresponding API keys.

cd docker-compose

docker-compose up

Modules

The following modules were enabled, to make use of all the functionality offered by the web-wallet.

• Wallet-Kit - exposes an API used by the wallet to enable the management of VCs, DIDs and their related keys.

• NFT-Kit - used as a native dependency to enable the display of NFTs in the wallet.

• Issuer Portal - the web page with which the wallet interacts to receive credentials.

• Verifier Portal - the web page with which the wallet interacts to do credential verification.

Runtime configurations

Find configuration options available for your wallet below. The docker-compose used a default setup for quick start.

Wallet-backend

• web.conf - host configuration

• storage configuration:

  • db.conf - database configuration

  • db.<database>.conf - datasource configuration

• wallet.conf - to enable credential, key and DID functions (wallet configuration)

• walt.yaml - to enable token display functions (NFTKit configuration)

Refer to the Configurations section for more details.

Wallet-frontend

When the wallet user starts an issuance flow from the wallet by clicking "request credential", the web-wallet needs to know the location where it should redirect the user to. This location is configured on the wallet-frontend side with the IssuerUrl environment variable.

Wallet Kit

Wallet Kit needs to be configured for the following modules:

Storage configuration describes which database should be used for data persistence and the connection string required to connect to the database. This information is organized in 2 separate configuration files:

1. db.conf - database configuration

2. db.<database>.conf - datasource configuration

Database configuration

Database configuration holds the datasource configuration filename (with no extension). The content of this configuration file will then be loaded and used as the connection string for the database. The filename should have the following format: db.<database> The database configuration is stored in the config/db.conf.

SQLite Config

database = "db.sqlite"

Postgres Config

database = "db.postgres"

Datasource Configs

They hold the connection string used to connect to the chosen database.

Sqlite Datasource Config

Can be found in config/db.sqlite.conf

hikariDataSource {
    jdbcUrl = "jdbc:sqlite:data.db"
    driverClassName = "org.sqlite.JDBC"
    username = ""
    password = ""
    transactionIsolation = "TRANSACTION_SERIALIZABLE"
    maximumPoolSize = 5
    autoCommit = false
    dataSource {
        journalMode = "WAL"
        fullColumnNames = false
    }
}

Postgres Datasource Config

Can be found in config/db.postgres.conf

hikariDataSource {
    jdbcUrl = "jdbc:postgresql://127.0.0.1:5432/postgres"
    driverClassName = "org.postgresql.Driver"
    username = "postgres"
    password = "postgres"
    transactionIsolation = "TRANSACTION_SERIALIZABLE"
    maximumPoolSize = 5
    minimumIdle: 0
    autoCommit = false
    dataSource {
        journalMode = WAL
        fullColumnNames = false
    }
}

Several options are available when it comes to using the web-wallet, depending on specific use-case:

• source code - when a higher level of customization is desired

• docker images - when a packaged solution is good enough

Considering the context, web-wallet offers the following functions:

• credential functions - functions related to verifiable credentials

• token functions - functions related to crypto collectibles

• key functions - display and manage cryptographic keys

• DID functions - display and manage DID methods

For more details about the available functions, check out the feature list which offers the option to explore all features in an overview list.

Credential functions

• view - display verifiable credentials

  • JSON format

  • QR-code

• delete - delete a credential from wallet

• receive - accept / reject credentials

  • synchronously - with a request string, either:

    • scanned from a QR code

    • or input explicitly

  • asynchronously - by means of the push-notifications service

• present - scan a credential presentation request

Token functions

• addresses - display and manage crypto wallets addresses

• tokens - display (and manage) crypto collectibles (NFTs)

Key functions

• import (JWK or PEM) - import any key (private or public) to wallet

• create - generate a key (private or public)

• view - display key information, such as algorithm, key-id or crypto-provider

• delete - delete a key from wallet

• export (JWK or PEM) - export a wallet key (private or public) using a given format

DID functions

• view - display the DID document of a DID url

  • JSON format

  • QR-code

• create - create a new DID using the available DID methods

Users can login with two options

1. Email

2. Web3 Accounts

   1. Ethereum - Learn more about Sign in with Ethereum here.

   2. Tezos - Learn more about Sign in with Tezos here.

   3. Near - Learn more about Sign in with Near here.

   4. Polkadot - Learn more about Sign in with Polkadot here.

   5. Flow - Learn more about Sign in with Flow here.

   6. Algorand - Learn more about Sign in with Algorand here.

Web-wallet is built as a monolithic repository were both the backend and frontend are part of the same repository.

Project requirements

• JDK 17+ - for wallet-backend

  • gradle v7.5.1 - to build the wallet-backend

• Node v.16+ - for wallet-frontend

  • pnpm v.8.1.0+ package manager - to run the wallet-frontend

Project setup

1. Clone waltid-identity

git clone https://github.com/walt-id/waltid-identity.git

1. Change into web-wallet backend folder

cd waltid-web-wallet

1. wallet-frontend source folder

cd waltid-web-wallet/web

Building the project

• wallet-backend

gradle clean build

• wallet-frontend

pnpm install

Runtime configurations

Refer to Runtime configurations from the Quick Start section.

Running the project

The modules referenced in the Requirements section from Quick Start need to be available before starting the web-wallet, so that all functions are enabled. Otherwise, the web-wallet will offer only account management functions (sign in / sign up, profile and settings).

1. start wallet-backend:

   • extract the build output (either .tar or .zip)

   Copy

   cd build/distributions &&
   tar xf waltid-web-wallet-0.0.1.tar

   • copy the configs from waltid-web-wallet/config to ./waltid-web-wallet-0.0.1/bin/config

   • execute

   Copy

   ./waltid-web-wallet-0.0.1/bin/waltid-web-wallet

2. start wallet-frontend

cd web &&
pnpm dev

Wallet-backend is available at: http://localhost:4545 (the port number configured in web.conf).

Wallet-frontend is available at: http://localhost:3000.

The Web-Wallet, our custodian wallet white-label solution, with which you can enable users to receive, share and store Verifiable Credentials, manage DIDs and their related keys and view tokens from different blockchain ecosystems. All in one place.

Getting Started

Depending on your preference, start exploring with the deep dive or jump directly to the setup.

Quick Start

Launch your wallet - Start the app in your local environment and receive the first VC.

Try it out!

Visit our deployed version - start issuing and verifying your own credentials.

Full Guide

Customize your wallet - Detailed presentation of the wallet app and its dependencies.

Deep dive

Architecture - The wallets components and which walt.id libs are used under the hood.

Functions - An overview of all the functionality offered by the wallet.

Configurations - Adjust settings to fit your needs.

Backend configurations

Web-wallet backend is configured with a set of files describing the configuration using the Hocon format (Human-Optimized Config Object Notation). Things that can be configured relate to:

Frontend configurations

• issuer-portal - the IssuerUrl environment variable should be set, specifying the location where the issuer-portal can be reached at. By default, it is set to http://localhost:8080. For local development, this can be updated in the wallet-frontend .env file:

Token-related configurations hold token auxiliary data mapping. Currently, there are 2 configurations available:

Chain explorer configuration

Chain explorer configuration holds the mapping of chains to their respective explorer location. It is stored in the chainexplorer.conf file.

e.g. chain explorer configuration

Marketplace configuration

Marketplace configuration holds the mapping of chains to their respective marketplace location. It is stored in the marketplace.conf file.

e.g. marketplace configuration

NFTKit configuration

In order to be able to fetch NFT data for owner addresses, the NFTKit dependency should also be configured for the desired chains.

Credential configurations set up the environment for functions related to authorization, credential, DID and key management. Currently, the following configurations are available:

Wallet configuration

specifies the remote location which web-wallet backend should use to proxy all the credential management, key management, DID management and authentication requests to. The configuration is stored in the wallet.conf file.

e.g. wallet configuration

Push notifications configuration

A push notifications service can be configured so that the end-user will receive notifications for both when they receive a credential accept request or a verification request. The configuration is stored in the push.conf file.

e.g. push notifications configuration