ChainGuard Developers
Version: 1.0.0
Last Updated: 18-11-2025
Status: In Progress
Table of Contents
- Overview
- What ChainGuard Offers Developers
- Quick Start
- Integration Options
- Developer Portal
- Getting Help
- Related Documentation
Overview
Welcome to the ChainGuard Developers section. This area provides everything you need to integrate ChainGuard's non-custodial Web3 security and identity infrastructure into your applications.
ChainGuard provides enterprise-grade authentication, authorization, and vault management services that enable you to:
- Authenticate users with OAuth 2.0 ("Login with ChainGuard")
- Access user data through secure API endpoints
- Enable vault operations for non-custodial asset management
- Integrate seamlessly with our JavaScript SDK
- Build secure applications with built-in compliance and audit logging
What ChainGuard Offers Developers
Core Services
1. OAuth 2.0 Provider
ChainGuard acts as a full OAuth 2.0 authorization server, enabling third-party applications to authenticate users and access user data with explicit consent.
- Authorization Code Flow: Standard OAuth 2.0 flow
- Token Management: Access tokens, refresh tokens, and token refresh
- Scope-Based Access: Fine-grained permission system
- Userinfo Endpoint: Standard OAuth userinfo endpoint
- PKCE Support: Enhanced security for public clients (planned)
2. JavaScript SDK
The Chain-Fi SDK provides a seamless way to integrate ChainGuard functionality into your web applications.
- QR Code Generation: Cross-device authentication
- Transaction Signing: Secure message signing with wallet verification
- Wallet Management: Retrieve and manage user wallet addresses
- Function Validation: Server-side validation of transaction functions
- Real-Time Communication: WebSocket-based real-time updates
3. Vault System
Non-custodial smart wallets with dual-signature enforcement and guardian-mediated gasless transactions.
- Vault Creation: Create non-custodial smart wallets for users
- Gasless Transactions: Guardian-mediated meta-transactions
- Direct Withdrawals: Emergency fallback with direct gas payment
- Multi-Chain Support: Deployed on Base, Arbitrum, and Optimism
- Multi-Asset Support: ETH, ERC20, ERC721, ERC1155
4. RESTful APIs
Comprehensive API endpoints for authentication, user data, vaults, and more.
- Authentication APIs: Register, login, profile management
- OAuth APIs: Authorization, token exchange, userinfo
- 2FA APIs: Setup, verification, reset
- Wallet APIs: Link, list, validate ownership
- Vault APIs: Create, status, link to user
- Billing APIs: Payment processing, subscription management
Quick Start
Get started with ChainGuard in 3 simple steps:
Step 1: Choose Your Integration Method
Option A: OAuth 2.0 Integration
- Best for: Web applications that need user authentication
- Time to integrate: ~30 minutes
- See: OAuth 2.0 Integration Guide
Option B: SDK Integration
- Best for: Applications needing QR code authentication and transaction signing
- Time to integrate: ~1 hour
- See: SDK Integration Guide
Option C: Vault Integration
- Best for: Applications managing user assets
- Time to integrate: ~2 hours
- See: Vault Integration Guide
Step 2: Register Your Application
- Access the Developer Portal (coming soon)
- Create a new application
- Configure OAuth redirect URIs
- Get your
client_idandclient_secret - (For SDK) Request an App ID
Step 3: Start Building
Follow the integration guide for your chosen method and start building!
Integration Options
OAuth 2.0 Integration
Integrate ChainGuard as an OAuth 2.0 provider to enable "Login with ChainGuard" in your application.
Key Features:
- Standard OAuth 2.0 authorization code flow
- Multiple scopes:
profile,email,wallets,vaults,activity - Token refresh for long-lived sessions
- Userinfo endpoint for user data
Use Cases:
- Web applications requiring user authentication
- Third-party services needing user data access
- Applications requiring wallet-linked user accounts
Get Started: OAuth 2.0 Integration Guide
SDK Integration
Use the Chain-Fi SDK to add QR code authentication, transaction signing, and wallet management to your application.
Key Features:
- QR code generation for mobile authentication
- Transaction signing with function validation
- Wallet address retrieval
- Device-wallet associations
- Real-time WebSocket communication
Use Cases:
- Applications requiring mobile device authentication
- DApps needing transaction signing capabilities
- Services requiring wallet address verification
Get Started: SDK Integration Guide
Vault Integration
Integrate ChainGuard's non-custodial vault system to enable secure asset management for your users.
Key Features:
- Non-custodial smart wallets
- Gasless transactions via guardian
- Direct withdrawal fallback
- Multi-chain support (Base, Arbitrum, Optimism)
- Multi-asset support (ETH, ERC20, ERC721, ERC1155)
Use Cases:
- DeFi applications
- NFT marketplaces
- Asset management platforms
- Multi-signature wallets
Get Started: Vault Integration Guide
Developer Portal
The ChainGuard Developer Portal (coming soon) provides a centralized dashboard for managing your integrations:
Features
- Application Management: Create and manage OAuth clients
- API Keys: Generate and manage API keys
- Analytics: View usage statistics, rate limits, and errors
- Webhooks: Configure webhook endpoints for real-time events
- Team Management: Invite team members and manage permissions
- Billing: View subscription details and usage
- Documentation: Access to all developer documentation
- Support: Direct access to developer support channels
Access
The Developer Portal will be available at: https://module.chain-fi.io/developers (coming soon)
Getting Help
Documentation
- Architecture Documentation: Complete system architecture and technical details
- Compliance Center: Regulatory compliance and data protection information
- API Reference: Complete API endpoint documentation
Support Channels
- Technical Support: support@chain-fi.io
- Developer Questions: dev@chain-fi.io
- Security Issues: security@chain-fi.io
Community
- GitHub: (Coming soon)
- Discord: (Coming soon)
- Status Page: (Coming soon)
Related Documentation
Technical Documentation
- System Architecture Overview - Complete system architecture
- OAuth Flow Documentation - Detailed OAuth 2.0 flow
- Vault System Documentation - Vault architecture and operations
- System Components - All system components and APIs
- Security Framework - Security controls and frameworks
Integration Guides
- OAuth 2.0 Integration - OAuth integration guide
- SDK Integration - SDK integration guide
- Vault Integration - Vault integration guide
Reference
- API Reference - Complete API documentation
- Developer Environment - Local development setup
- Resources - Additional resources and support
Next Steps
- Choose your integration method from the options above
- Read the integration guide for your chosen method
- Set up your development environment using our Developer Environment Guide
- Register your application in the Developer Portal (coming soon)
- Start building and integrate ChainGuard into your application!
Ready to get started? Choose an integration method above and follow the guide!