Hashgraph Cryptosuites SDK
Complete implementation of the W3C Data Integrity specification for creating and verifying data integrity proofs across decentralized systems.
Quick Start
npm install @the-hashgraph-group-ag/cryptosuites-core
npm install @the-hashgraph-group-ag/cryptosuites-eddsa-v1
npm install @the-hashgraph-group-ag/signer-internal-ed25519
import {
ProofCreator,
ProofVerifier,
Signer,
canonicalizer,
hashing
} from '@the-hashgraph-group-ag/cryptosuites-core';
Core Features
-
W3C Data Integrity Compliance - Full implementation of the W3C Data Integrity specification
-
Multiple Cryptosuites - Support for EdDSA, Ed25519, and extensible architecture
-
JSON Canonicalization - RFC 8785 compliant JSON canonicalization
-
Flexible Signing - Abstract interfaces for custom signing implementations
-
TypeScript Support - Full TypeScript support with comprehensive type definitions
Architecture Overview
The SDK is built with a modular architecture consisting of:
-
Core Package - Fundamental interfaces and utilities (this package)
-
Cryptosuites - Implementation of specific cryptographic suites
-
Signers & Verifiers - Concrete signing and verification implementations
Package Information
-
Package:
@the-hashgraph-group-ag/cryptosuites-core -
Version: Latest stable release
-
License: Apache 2.0
-
Source: https://github.com/Swiss-Digital-Assets-Institute/hashgraph-cryptosuites-sdk-js
Quick Navigation
Core Classes
-
BaseException - Base exception class for all SDK exceptions
-
JSONCanonicalizationScheme - RFC 8785 JSON canonicalization implementation
-
MultibaseCodec - Multibase encoding/decoding utility
-
ProofCreator - Abstract class for creating cryptographic proofs
-
ProofVerifier - Abstract class for verifying cryptographic proofs
-
SHA256HashingAlgorithm - SHA-256 hashing implementation
-
Signer - Abstract signing operations interface
-
Verifier - Abstract verification operations interface
Core Interfaces
-
BaseJWK - Common JWK parameters for all key types
-
Canonicalizer - JSON canonicalization interface
-
HashingAlgorithm - Cryptographic hashing interface
-
InputDocument - Base document interface
-
Proof - Data Integrity Proof object interface
-
ProofConfig - Proof configuration interface
-
ProofOptions - Proof creation options
-
ProofSigningRequest - Proof signing request interface
-
SecuredDataDocument - Document with attached proofs
-
VerificationData - Proof verification data interface
-
VerifierOptions - Verification options interface
Type Definitions
-
JWK - Union type for all JWK key types
-
MultibaseAlgorithm - Supported multibase algorithms
-
ProofPurpose - Valid proof purposes
-
UnsecuredDocument - Unsecured document type
Utilities
-
canonicalizer - Canonicalization utilities
-
hashing - Hashing algorithm utilities
-
concatUint8Arrays - Array concatenation utility
Package Information
-
Package:
@the-hashgraph-group-ag/cryptosuites-core -
Version: Latest stable release
-
License: Apache 2.0
-
Source: https://github.com/Swiss-Digital-Assets-Institute/hashgraph-cryptosuites-sdk-js