Download

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt Use this file to discover all available pages before exploring further.

Download

Install and start the Wallet Gateway

This guide will help you get the Wallet Gateway up and running quickly.

Installation

Choose your preferred installation method:

Global Installation (npm):

Install the Wallet Gateway globally using npm:

npm install -g @canton-network/wallet-gateway-remote

After installation, you can run it from anywhere:

wallet-gateway -c ./config.json

Run with npx (No Installation):

Run the Wallet Gateway directly through npx without installing (tested with Node.js v24):

npx @canton-network/wallet-gateway-remote -c ./config.json

This downloads and runs the latest version each time, useful for testing or one-off runs.

Quick Start

1. Create a Configuration File

   First, generate an example configuration file:

   Global Installation:

   wallet-gateway --config-example > config.json

   npx:

   npx @canton-network/wallet-gateway-remote --config-example > config.json

2. Edit the Configuration

   Open config.json and customize it for your environment. At minimum, you’ll need to configure:

   • Store connection: Database configuration (in-memory, SQLite, or PostgreSQL)
   • Networks: At least one Canton network with its Ledger API endpoint
   • Identity Providers: Authentication configuration for your networks

   See Configuration for detailed configuration options.

3. Start the Gateway

   Global Installation:

   wallet-gateway -c ./config.json

   Or with a custom port:

   wallet-gateway -c ./config.json -p 8080

   npx:

   npx @canton-network/wallet-gateway-remote -c ./config.json

   Or with a custom port:

   npx @canton-network/wallet-gateway-remote -c ./config.json -p 8080

4. Verify it’s Running

   Once started, the Wallet Gateway exposes three endpoints:

   • Web UI: http://localhost:3030 (or your configured port)
   • dApp JSON-RPC API: http://localhost:3030/api/v0/dapp
   • User JSON-RPC API: http://localhost:3030/api/v0/user

   Open the web UI in your browser to confirm it’s running.

Command Line Options

The Wallet Gateway supports the following command-line options:

-c, --config <path>          Set config path (default: ./config.json)
--config-schema              Output the config schema (JSON Schema) and exit
--config-example             Output an example config and exit
-p, --port [port]            Set port (overrides config file)
-f, --log-format <format>    Set log format: json or pretty (default: pretty)

Example:

Global Installation:

# Generate config schema
wallet-gateway --config-schema

# Run with JSON logging
wallet-gateway -c ./config.json -f json

npx:

# Generate config schema
npx @canton-network/wallet-gateway-remote --config-schema

# Run with JSON logging
npx @canton-network/wallet-gateway-remote -c ./config.json -f json

Configuration Schema

To see the full JSON Schema for the configuration file, run:

Global Installation:

wallet-gateway --config-schema

npx:

npx @canton-network/wallet-gateway-remote --config-schema

This outputs a complete JSON Schema that can be used for validation and IDE autocomplete support.

Next Steps

• Read Configuration to understand all configuration options
• Explore the APIs to understand how to interact with the Gateway
• Learn about Signing Providers to configure transaction signing
• Check out the Deployment guide to host the Gateway with Docker or Helm
• Check Troubleshooting if you encounter any issues

Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.