Wallet SDK Core

Modules

Biometric plugin for the Truvera Wallet SDK. This module provides functions for biometric enrollment, matching, and identity verification processes.

cloud-wallet

Cloud wallet functionality for the Truvera Wallet SDK. This module provides the main cloud wallet creation and management functions.

credential-provider

Verifiable credential management functionality for the Truvera Wallet SDK. This module provides functions for importing, verifying, storing, and managing verifiable credentials.

did-provider

DID (Decentralized Identifier) management functionality for the Truvera Wallet SDK. This module provides functions for creating, importing, exporting, and managing DIDs.

message-provider

DIDComm message management functionality for the Truvera Wallet SDK. This module provides functions for sending, receiving, and processing DIDComm messages.

wallet

Core wallet functionality for the Dock Wallet SDK. This module provides the main wallet creation and management functions.

Classes

DefaultQRCodeProcessor

Default implementation of QRCodeProcessor

This processor manages a registry of QR code handlers and executes them in priority order to process scanned QR codes. It provides a flexible, extensible system for handling various types of QR codes in a wallet application.

OID4VCHandler

Built-in handler for OID4VC (OpenID for Verifiable Credentials) URIs

This is a generic handler that can be configured with app-specific callbacks for importing credentials. The handler itself only handles protocol detection and delegates the actual import logic to the configured callback.

Example Usage

import { OID4VCHandler } from '@docknetwork/wallet-sdk-core/src/qr-handlers/builtin';
import { getCredentialProvider } from '@docknetwork/wallet-sdk-react-native';
const handler = new OID4VCHandler({
  onImportCredential: async (uri, context) => {
    try {
      // Use SDK to import credential
      await getCredentialProvider().importCredentialFromURI({
        uri,
        didProvider: getDIDProvider(),
        getAuthCode: async (authUrl) => {
          // App-specific auth handling
          return await showAuthWebView(authUrl);
        },
      });
  return { success: true };} catch (error) {  return {    success: false,    error: error instanceof Error ? error : new Error(String(error)),  };}
  },
});
processor.registerHandler(handler);

Handler Priority

Default priority: 5 (very high) This ensures OID4VC URIs are checked before other credential handlers.

Members

Goals ⇒dockDocumentNetworkResolver

Given an Api URL, resolve the network ID For now it will be applied for creds and certs It can be extended to resolve other external URLs

OID4VCHandler ⇒

Create an OID4VC handler with custom configuration

This is a convenience factory function for creating an OID4VC handler.

DefaultQRCodeProcessor ⇒

Create a new QR code processor instance

This is a convenience factory function for creating a processor.

Constants

MessageTypes

DIDComm Message helpers Check https://identity.foundation/didcomm-messaging/spec/#out-of-band-messages for more details

Functions

buildRequestVerifiablePresentationMessage()

Sender: Verifier OOB message to request a verifiable presentation from the holder

buildAckWalletToWalletVerificationMessage()

Sender: Holder Start a wallet to wallet verification flow

buildVerifiablePresentationMessage()

Sender: Holder Send a verifiable presentation to the verifier

buildVerifiablePresentationAckMessage()

Sender: Verifier Sends an the presentation result to the holder

handleBlockchainNetworkChange()

Update existing substrate network connection Compare connected substrate connection with the current walle network Disconnect and Establish a new connection if the network is different

Typedefs

WalletStatus : 'closed' | 'loading' | 'ready' | 'error'

Possible wallet status values

KeypairType : 'sr25519' | 'ed25519' | 'ecdsa'

Supported keypair types

BiometricsProviderConfigs : Object

Configuration options for biometric provider operations

Interfaces

~~IV1Wallet~~

Legacy V1 wallet interface for backward compatibility

IWallet ⇐ IV1Wallet

Main wallet interface providing methods for document management, import/export, and network operations.

IDIDProvider

Provides a high-level API for DID management operations

IMessageProvider

Provides a high-level API for DIDComm message management operations

ICredentialProvider

Provides a high-level API for verifiable credential management operations

IDVProcessOptions

Callback functions for handling different stages of the identity verification process

BiometricPlugin

Defines the contract for biometric enrollment and matching operations

IDVProvider

Defines the contract for identity verification operations

IDVProviderFactory

Creates IDV provider instances with proper event handling and wallet integration

IBiometricProvider

Provides a high-level API for biometric identity verification operations

biometric-provider

Biometric plugin for the Truvera Wallet SDK. This module provides functions for biometric enrollment, matching, and identity verification processes.

biometric-provider
- static
  - .IDV_EVENTS ⇒ IBiometricProvider
- inner
  - ~setConfigs(configs)
  - ~isBiometricPluginEnabled() ⇒ boolean
  - ~assertConfigs()
  - ~getBiometricConfigs() ⇒ BiometricsProviderConfigs.<unknown>
  - ~hasProofOfBiometrics(proofRequest) ⇒ boolean

biometric-provider.IDV_EVENTS ⇒ `IBiometricProvider`

Creates a biometric provider instance for identity verification and biometric credential management

Kind: static property of biometric-provider
Returns: IBiometricProvider -

A biometric provider instance with identity verification methods

Throws:

Error

If wallet or idvProviderFactory is not provided

See: IBiometricProvider - The interface defining all available biometric provider methods

Param	Type	Description
params	`Object`	Provider configuration
params.wallet	`IWallet`	The wallet instance to use for credential storage
params.idvProviderFactory	`IDVProviderFactory`	Factory for creating IDV provider instances

Example

import { createBiometricProvider } from '@docknetwork/wallet-sdk-core';

const biometricProvider = createBiometricProvider({
  wallet,
  idvProviderFactory: myIDVFactory
});

// Start identity verification process
const result = await biometricProvider.startIDV(proofRequest);
console.log('Enrollment credential:', result.enrollmentCredential);
console.log('Match credential:', result.matchCredential);

// Listen for IDV events
biometricProvider.eventEmitter.on('onComplete', (data) => {
  console.log('IDV process completed:', data);
});

biometric-provider~setConfigs(configs)

Sets the global biometric provider configurations for the SDK

Kind: inner method of biometric-provider

Param	Type	Description
configs	`BiometricsProviderConfigs.<unknown>`	The biometric provider configurations to set
configs.enrollmentCredentialType	`string`	The credential type for enrollment
configs.biometricMatchCredentialType	`string`	The credential type for biometric matching
[configs.idvProvider]	`any`	Optional IDV provider configuration

Example

import { setConfigs } from '@docknetwork/wallet-sdk-core/biometric-provider';

setConfigs({
  enrollmentCredentialType: 'BiometricEnrollment',
  biometricMatchCredentialType: 'BiometricMatch',
  idvProvider: myIDVProviderConfig
});

biometric-provider~isBiometricPluginEnabled() ⇒ `boolean`

Checks if the biometric plugin is enabled by verifying if biometric match credential type is configured

Kind: inner method of biometric-provider
Returns: boolean -

True if biometric match credential type is configured, false otherwise

Example

import { isBiometricPluginEnabled, setConfigs } from '@docknetwork/wallet-sdk-core/biometric-provider';

// Before configuration
console.log(isBiometricPluginEnabled()); // false

// After configuration
setConfigs({
  enrollmentCredentialType: 'BiometricEnrollment',
  biometricMatchCredentialType: 'BiometricMatch'
});
console.log(isBiometricPluginEnabled()); // true

biometric-provider~assertConfigs()

Asserts that biometric provider configurations are available

Kind: inner method of biometric-provider
Throws:

Error

If biometric provider configs are not set

Example

import { assertConfigs } from '@docknetwork/wallet-sdk-core/biometric-provider';

try {
  assertConfigs();
  console.log('Biometric configs are available');
} catch (error) {
  console.error('Biometric configs missing:', error.message);
}

biometric-provider~getBiometricConfigs() ⇒ `BiometricsProviderConfigs.<unknown>`

Gets the current biometric provider configurations

Kind: inner method of biometric-provider
Returns: BiometricsProviderConfigs.<unknown> -

The current biometric provider configurations

Throws:

Error

If biometric provider configs are not set

Example

import { getBiometricConfigs } from '@docknetwork/wallet-sdk-core/biometric-provider';

try {
  const configs = getBiometricConfigs();
  console.log('Enrollment credential type:', configs.enrollmentCredentialType);
  console.log('Match credential type:', configs.biometricMatchCredentialType);
} catch (error) {
  console.error('Failed to get configs:', error.message);
}

biometric-provider~hasProofOfBiometrics(proofRequest) ⇒ `boolean`

Checks if a proof request requires biometric credentials

Kind: inner method of biometric-provider
Returns: boolean -

True if the proof request requires biometric credentials

Param	Type	Description
proofRequest	`any`	The proof request to analyze

Example

import { hasProofOfBiometrics } from '@docknetwork/wallet-sdk-core/biometric-provider';

const proofRequest = {
  input_descriptors: [{
    constraints: {
      fields: [{
        path: ['$.credentialSubject.biometric.id']
      }, {
        path: ['$.credentialSubject.biometric.created']
      }]
    }
  }]
};

if (hasProofOfBiometrics(proofRequest)) {
  console.log('This proof request requires biometric verification');
}

cloud-wallet

Cloud wallet functionality for the Truvera Wallet SDK. This module provides the main cloud wallet creation and management functions.

cloud-wallet