@canton-network/core-signing-blockdaemon

This package provides a signing driver for integrating the Wallet Gateway with Blockdaemon. It implements the SigningDriverInterface defined in @canton-network/core-signing-lib, allowing the Wallet Gateway to manage keys and sign transactions using Blockdaemon's infrastructure.

Installation

This package is part of the Wallet Gateway monorepo and is typically installed as a workspace dependency.

pnpm add @canton-network/core-signing-blockdaemon

Usage

The BlockdaemonSigningDriver is designed to be used within the Wallet Gateway's signing architecture. It requires a configuration object containing the baseUrl and apiKey for the Blockdaemon service.

Initialization

import BlockdaemonSigningDriver, {
    BlockdaemonConfig,
} from '@canton-network/core-signing-blockdaemon'

const config: BlockdaemonConfig = {
    baseUrl: 'https://api.blockdaemon.com/...', // Replace with actual Blockdaemon API URL
    apiKey: 'your-api-key',
}

const driver = new BlockdaemonSigningDriver(config)

Features

The driver supports the following operations:

• Key Management:
  • createKey: Creates a new key pair on Blockdaemon.
  • getKeys: Retrieves a list of available keys.
• Signing:
  • signTransaction: Signs a transaction using a specified key.
• Transaction Monitoring:
  • getTransaction: Retrieves the status and details of a specific transaction.
  • getTransactions: Retrieves a list of transactions based on transaction IDs or public keys.
• Configuration:
  • getConfiguration: Returns the current configuration (masking sensitive secrets).
  • setConfiguration: Updates the driver's configuration at runtime.

Integration

This driver is intended to be registered with the SigningController in the Wallet Gateway, which manages multiple signing providers.

// Example integration (conceptual)
import { SigningController } from '@canton-network/core-signing-internal' // or similar

const signingController = new SigningController()
signingController.registerDriver(driver)

Configuration

The driver accepts a BlockdaemonConfig object:

| Property | Type | Description | | :-------- | :------- | :-------------------------------------------- | | baseUrl | string | The base URL for the Blockdaemon Signing API. | | apiKey | string | The API key for authentication. |

Wallet Gateway Configuration

When running the Wallet Gateway (Remote), the Blockdaemon signing driver is configured using the following environment variables:

• BLOCKDAEMON_API_URL: The base URL for the Blockdaemon API. Defaults to http://localhost:5080/api/cwp/canton if not set.
• BLOCKDAEMON_API_KEY: The API key for authenticating with Blockdaemon.

Example usage:

BLOCKDAEMON_API_URL="https://api.blockdaemon.com/..." BLOCKDAEMON_API_KEY="your-api-key" pnpm start

License

Apache-2.0