How-To Guides
Welcome to TrustWeave’s How-To Guides! These guides are task-oriented and show you how to accomplish specific goals with TrustWeave.
What are How-To Guides?
How-To Guides are practical, step-by-step instructions for completing specific tasks. They differ from:
- Tutorials: Step-by-step learning experiences that teach concepts while building something
- Concepts: Explanations of what things are and why they exist
- API Reference: Complete documentation of all methods and parameters
How to Use These Guides
- Find the task you want to accomplish - Browse the guides below or use search
- Follow the step-by-step instructions - Each guide includes complete, runnable examples
- Adapt to your needs - Use the examples as starting points for your own code
- Refer to API Reference - For detailed parameter documentation, see the API Reference
Available Guides
Core Tasks
These guides cover the essential operations you’ll use in most TrustWeave applications:
- Use TrustWeave Facade - Quick setup with sensible defaults (start here!)
- Configure TrustWeave - Declarative DSL configuration
- Create and Manage DIDs - Create, resolve, update, and deactivate DIDs
- Issue Credentials - Issue verifiable credentials with proofs
- Verify Credentials - Verify credentials and check validity
- Manage Wallets - Store, organize, and present credentials
- Anchor to Blockchain - Anchor data for tamper evidence
- Multi-Chain Anchoring - Anchor to multiple blockchains for redundancy
- Exchange Credentials - Exchange credentials using multiple protocols (DIDComm, OIDC4VCI, CHAPI)
- Handle Errors - Error handling patterns and best practices
Advanced Tasks
For more complex scenarios and customization:
- Rotate Keys - Rotate cryptographic keys while preserving credential history
- Configure Verification Policies - Customize verification behavior
- Build Custom Adapters - Create custom implementations
- Implement SPI Plugins - Build pluggable components
- Optimize Performance - Performance tuning and best practices
Integration Guides
Connect TrustWeave to external services:
- KMS Integrations - AWS KMS, Azure Key Vault, Google Cloud KMS, HashiCorp Vault
- DID Method Integrations - did:key, did:web, did:ion, did:ethr, and more
- Blockchain Integrations - Algorand, Ethereum, Polygon, Base, Arbitrum
Quick Start
New to TrustWeave? Start with these guides in order:
- Use TrustWeave Facade - Quick setup and your first credential (3 lines!)
- Configure TrustWeave - Learn declarative configuration
- Create and Manage DIDs - Learn how to create identities
- Issue Credentials - Issue your first credential
- Verify Credentials - Verify credentials
- Manage Wallets - Store and organize credentials
Already familiar? Jump to the guide for your specific task.
Guide Structure
Each how-to guide follows this structure:
- Prerequisites - What you need before starting
- Expected Outcome - What you’ll achieve
- Quick Example - A complete, runnable example you can copy and run
- Step-by-Step Guide - Detailed instructions with step markers and code at each step
- Common Patterns - Real-world usage patterns
- Error Handling - How to handle errors for this task
- Next Steps - What to learn next
- Related Resources - Links to concepts, API reference, and scenarios
Note: Guides include code snippets at the right steps (not dumped at the end), and workflow diagrams where multiple components interact.
Related Documentation
- Tutorials - Step-by-step learning experiences
- Concepts - Understanding the “why” behind TrustWeave
- API Reference - Complete API documentation
- Use Case Scenarios - Real-world examples
Next Steps
Ready to start?
- Use TrustWeave Facade - Quickest way to get started (3 lines!)
- Configure TrustWeave - Learn declarative configuration
- Create and Manage DIDs - Your first task
- Issue Credentials - Issue your first credential
Want to learn more?