diff --git a/.gitignore b/.gitignore index 032d1f01b..bcd741b02 100755 --- a/.gitignore +++ b/.gitignore @@ -123,3 +123,4 @@ tmp-openapi-gen/**/*.json .mcp.json node_modules .claude +.blume/ diff --git a/docs/changelog.mdx b/docs/changelog.mdx deleted file mode 100644 index e16c3246f..000000000 --- a/docs/changelog.mdx +++ /dev/null @@ -1,580 +0,0 @@ ---- -title: Version History -sidebarTitle: Changelog -description: All notable changes to the Sonr blockchain -icon: "hourglass" ---- - - - - Consolidate deployment infrastructure with Docker Compose and enhance build targets (#248) - - Unified backend services configuration (Highway, Redis, Caddy, IPFS, snrd) - - Implemented multi-stage Dockerfile build targets - - Enhanced Makefile with Docker management targets - - Introduced health check and readiness probe system - - - - Implement OpenID Connect provider with WebAuthn in bridge handlers (#244) - - Full WebAuthn passwordless authentication integration - - Implemented Self-Issued OpenID Provider (SIOP) v2 - - Blockchain-based WebAuthn credential broadcasting - - Supports Authorization Code Flow with PKCE - - - - Fix cryptographic implementations and enable disabled tests (#243) - - Fixed and re-enabled previously disabled cryptographic tests - - Enhanced security validation for cryptographic modules - - Improved test coverage for core security components - - ---- - - - WebAuthn attestation and verification improvements (#242) - - Enhanced attestation verification logic - - Improved security checks for authentication ceremonies - - Refined credential validation mechanisms - - - - Implement Service module capability system and parameters (#241) - - Introduced comprehensive capability management for services - - Added robust parameter validation for service configurations - - Enhanced service module flexibility and security - - - - Complete DID module WebAuthn and parameter implementation (#240) - - Full W3C WebAuthn Level 2 compliance with passwordless authentication - - Implemented CBOR-based attestation parsing - - Multi-algorithm signature verification (ES256, RS256, EdDSA) - - Added 9 new DID module parameters with validation - - - - Introduce key rotation events and IPFS status endpoint (#238) - - Vault key rotation with Motor plugin integration - - Consensus-based encryption using validator set - - HMAC-SHA256 validation for data integrity - - IPFS status query endpoint with health metrics - - - - Implement module parameter validation and defaults (#237) - - Comprehensive parameter validation for DID and SVC modules - - Default parameters with FIDO2-compliant WebAuthn settings - - Enhanced parameter validation for service limits and timeouts - - - - Complete remaining event emissions for DID and DWN modules (#235) - - Implemented typed Protobuf events for all state-changing operations - - Added detailed event types with enhanced observability - - Updated event emission patterns to follow Cosmos SDK v0.50.14 best practices - - - - Implement typed Protobuf events for x/did, x/dwn, and x/svc modules (#233) - - Typed events following Cosmos SDK's ADR-032 pattern - - Event-driven application support with CometBFT websockets - - Backward compatibility maintained with legacy events - - - - Integrate Interchain Accounts for cross-chain DEX functionality - - Enhanced cross-chain interoperability for trading - - IBC integration for decentralized exchange operations - - - - Implement ICA Controller system in x/dex module for cross-chain DEX operations (#221) - - Full Interchain Account Controller implementation - - Cross-chain DEX trading capability - - Enhanced IBC protocol support - - - - Replace InterchainTest with Starship-based E2E testing framework (#217) - - Modern testing infrastructure with Starship - - Improved E2E test reliability and speed - - Better multi-chain testing support - - - - Add support for additional elliptic curves and JWK verification (#216) - - Extended elliptic curve support beyond secp256k1 - - JSON Web Key (JWK) verification implementation - - Enhanced cryptographic flexibility - - ---- - - - Complete WebAuthn/FIDO2 implementation for passwordless authentication (#215) - - Full FIDO2 compliance with passwordless authentication - - Hardware security key support - - Biometric authentication integration - - - - Complete DID keeper implementation with W3C compliance and WebAuthn authentication (#214) - - Full W3C DID specification compliance - - WebAuthn integration for DID authentication - - Enhanced identity management capabilities - - - - Transform UI package to shadcn monorepo architecture for uniform styling (#213) - - Migrated to shadcn component architecture - - Consistent design system across applications - - Improved component reusability - - - - Improve secure memory handling for enhanced security (#201) - - Zero-memory clearing for sensitive data - - Protected memory allocation for cryptographic operations - - Enhanced key material security - - - - Implement comprehensive cryptographic security enhancements (#200) - - Major cryptographic subsystem overhaul - - Enhanced encryption algorithms - - Improved key management system - - ---- - - - Implement CLI commands for wallet module (#198) - - Comprehensive wallet management via CLI - - Transaction signing and broadcasting commands - - Key management operations - - - - Implement UCAN permission validation for wallet transactions (#197) - - User-Controlled Authorization Networks integration - - Permission-based transaction validation - - Enhanced wallet security model - - - - Implement Go client SDK with transaction signing and broadcasting (#196) - - Complete Go SDK for chain interaction - - Transaction building and signing utilities - - gRPC and REST endpoint support - - - - Enable Docker-based testnet execution - - Simplified testnet deployment via Docker - - Containerized node operation - - Quick local testing environment - - - - Implement monorepo structure with pnpm workspaces and changesets (#189) - - Modern monorepo architecture - - pnpm workspace management - - Automated versioning with changesets - - - - Implement WebAuthn gasless transactions with comprehensive protocol integration (#186) - - Gasless onboarding for new users - - WebAuthn-based transaction signing - - Eliminated token requirement for registration - - - - Implement gasless WebAuthn registration with comprehensive security audit (#182) - - Security-audited gasless registration flow - - Anti-abuse mechanisms - - Credential uniqueness enforcement - - - - Implement consensus-based encryption for DWN module (#181) - - Validator-based encryption keys - - Consensus-driven key management - - Enhanced data privacy - - - - Enhance init command with VRF keypair generation and SonrContext system (#180) - - Verifiable Random Function integration - - SonrContext for session management - - Enhanced initialization process - - - - Move interchain tests to dedicated location (#178) - - Improved test organization - - Separated integration tests - - Better test maintainability - - - - Refactor Motor WASM plugin as MPC-based UCAN source (#177) - - Multi-party computation integration - - WASM-based secure execution - - UCAN capability management - - - - Migrate documentation to Mintlify structure (#172) and migrate x/ucan module to internal library (#174) - - Documentation platform migration - - UCAN module refactoring - - Improved code organization - - - - Implement WebAuthn CLI registration with gasless transactions (#168) - - CLI-based WebAuthn registration - - Browser integration for credential creation - - Gasless onboarding flow - - - - Implement auto-create DWN vault with comprehensive security improvements (#161) - - Automatic vault provisioning - - Enhanced security measures - - Improved user onboarding - - - - Migrate Highway service to Echo framework with WebSocket/SSE and JWT auth (#159) - - Echo framework migration - - Real-time WebSocket support - - JWT authentication system - - - - Complete Highway proxy server implementation with asynq and proto.Actor (#157) - - Asynq task queue integration - - Actor-based concurrency model - - Improved task processing - - - - Refactor x/dwn vaults and introduce gasless transactions (#154) - - Vault system refactoring - - Gasless transaction support - - Enhanced user experience - - - - Monorepo restructure with internal packages and enhanced CI/CD (#151) - - Internal package architecture - - CI/CD pipeline improvements - - Better code organization - - - - Enhance testnet configuration with faucet and explorer settings (#145) - - Testnet faucet integration - - Block explorer configuration - - Improved developer experience - - - - Optimize deployment workflows and update infrastructure configuration (#141) - - Streamlined deployment process - - Infrastructure updates - - Performance optimizations - - - - Introduce Starship network configurations for devnet and testnet (#139) - - Starship integration for local development - - Multi-network configuration support - - Simplified network management - - - - Streamline Docker build for enhanced efficiency (#136) - - Optimized Docker build process - - Reduced image sizes - - Faster build times - - - - Streamline starship configuration and local development (#135) - - Simplified Starship setup - - Enhanced local development workflow - - Better developer experience - - - - Major infrastructure and wallet improvements (#134, #131, #128, #127) - - Optimized CI/CD workflows with smart testing - - Fee grant integration with BasicAllowance - - EVM transaction support in wallet module - - External wallet linking as DID assertion methods - - - - Implement secure key management with WASM enclaves (#126) - - WASM-based secure enclaves - - Hardware-level key protection - - Enhanced cryptographic isolation - - ---- - - - Implement vault export/import with IPFS encryption (#125) - - IPFS-based vault backup - - Encrypted vault exports - - Decentralized storage integration - - - - Add transaction building framework and streamline release process (#123) - - Comprehensive transaction builder - - Automated release pipeline - - Improved developer tools - - - - Add cross-module keeper integration tests and optimize CI performance (#122) - - Cross-module testing framework - - CI pipeline optimization - - Better test coverage - - - - Improve service validation and UCAN integration (#121) - - Enhanced service validation logic - - UCAN capability improvements - - Better error handling - - - - Implement ServiceKeeper interface for x/dwn module (#120) - - Service abstraction layer - - Improved module interactions - - Enhanced modularity - - - - Implement UCANKeeper interface for x/dwn module (#119) - - UCAN integration for DWN - - Capability-based permissions - - Enhanced authorization - - - - Implement UCANKeeper interface for x/svc module (#117) - - Service module UCAN support - - Permission management - - Improved security model - - - - Implement DIDKeeper interface for x/svc module (#116) - - DID integration for services - - Identity-based service management - - Enhanced authentication - - - - Implement ServiceKeeper interface methods in x/svc keeper (#113) - - Complete service keeper implementation - - Core service functionality - - Module integration - - - - Implement UCANKeeper interface methods and centralize error handling (#112) - - UCAN keeper implementation - - Centralized error management - - Improved code maintainability - - - - Implement VerifyDIDDocumentSignature method with multi-algorithm support (#111) - - Multi-algorithm signature verification - - Ed25519, ECDSA, RSA support - - Enhanced DID security - - - - Implement wallet derivation and keeper interface architecture (#110) - - HD wallet derivation - - Keeper interface design - - Improved wallet architecture - - - - Introduce VaultKeeper interface for enhanced modularity (#99) - - Vault abstraction layer - - Improved code organization - - Better testability - - - - Enable DWN vault spawning via query API and add comprehensive tests (#98) - - Query-based vault creation - - Comprehensive test suite - - API improvements - - - - Update testnet configuration for DAO governance (#84) - - DAO governance integration - - Testnet parameter updates - - Governance readiness - - - - Centralize vault actor system and optimize plugin management (#83) - - Actor system centralization - - Plugin optimization - - Performance improvements - - - - Refactor x/dwn module structure and integrate WebAssembly motor client (#81) - - Major DWN module refactoring - - WASM motor client integration - - Enhanced documentation - - ---- - - - Implement Rybbit analytics and update documentation site styling (#80) - - Analytics integration - - Documentation improvements - - Better user insights - - - - Complete shadcn/TemplUI migration from NebulaUI (#79) - - UI library migration - - Modern component system - - Improved styling - - - - Enhanced documentation landing page with custom branding (#69) - - Custom branding implementation - - Improved documentation UI - - Better user experience - - - - Integrate Trunk.io for code quality and linting (#65) - - Trunk.io integration - - Automated code quality checks - - Enhanced linting rules - - ---- - - - Implement DWN module with enclave signing and DIF specification (#64) - - Decentralized Web Node implementation - - DIF specification compliance - - Enclave-based signing - - ---- - - - ES-client protobuf generation (#63) - - JavaScript client protobuf support - - Improved client SDK - - Better developer tools - - - - Automated API Reference Generation for Cosmos Modules and Highway REST Service (#62) - - Automated API documentation - - REST service documentation - - Improved developer resources - - ---- - - - Enhance TUI Dashboard with real-time data visualization and testnet support (#59) - - Real-time data visualization - - Testnet dashboard support - - Enhanced monitoring - - - - Implement x/ucan msgServer handlers with capability templates (#55) - - UCAN message handlers - - Capability templates - - Authorization framework - - ---- - - - Integrate Nebula UI Component Library (#54) - - UI component library integration - - Reusable components - - Design consistency - - - - W3C DID Controller with WebAuthn support and comprehensive testing improvements (#52) - - W3C DID controller implementation - - WebAuthn authentication - - Enhanced test coverage - - ---- - - - Migrate UCAN capability definitions to x/ucan module (#49) - - UCAN module creation - - Capability migration - - Improved architecture - - ---- - - - Implement DNS record verification with UCAN delegation for x/svc (#41) - - DNS verification system - - UCAN-based delegation - - Service authentication - - ---- - - - Implement Highway Service API Handlers (#39) - - Highway service implementation - - API handler creation - - Core service functionality - - - - Major infrastructure and documentation improvements (#38, #37, #36) - - IPFS private network support - - Enhanced CI/CD workflows - - Comprehensive tokenomics documentation - - Client integration guide - - Research section with whitepapers - - - - Initial release with core blockchain features - - Automated version bumping and changelog generation - - Highway service for enhanced authentication - - Database migration using goose - - CosmWasm VM for smart contracts - - IPFS Kubo v0.35.0 integration - - Decentralized web node runtime with WASM enclave - - Complete database schema for core entities - diff --git a/docs/docs.json b/docs/docs.json deleted file mode 100644 index 06337b5a8..000000000 --- a/docs/docs.json +++ /dev/null @@ -1,366 +0,0 @@ -{ - "$schema": "https://mintlify.com/docs.json", - "theme": "maple", - "name": "Sonr Docs", - "logo": { - "light": "https://cdn.sonr.io/logos/docs/logo.svg", - "dark": "https://cdn.sonr.io/logos/docs/logo-dark.svg" - }, - "favicon": "https://cdn.sonr.io/favicon.ico", - "colors": { - "primary": "#17c2FF", - "light": "#17c2FF", - "dark": "#279cff" - }, - "icons": { - "library": "lucide" - }, - "navigation": { - "dropdowns": [ - { - "dropdown": "Documentation", - "description": "Sonr Fundamentals", - "icon": "lightbulb", - "pages": [ - { - "group": "Getting Started", - "icon": "rocket", - "pages": [ - "index", - "reference/install", - "changelog", - "faq" - ] - }, - { - "group": "Learn Concepts", - "icon": "lightbulb", - "pages": [ - { - "group": "Sonr Blockchain", - "icon": "combine", - "pages": ["concepts/sonr", "modules/did/index", "modules/dwn/index", "modules/svc/index", "modules/dex/index"] - }, - { - "group": "Gateway Services", - "icon": "radio-tower", - "pages": [ - "concepts/hway", - "concepts/gasless-onboarding", - "concepts/webauthn-integration" - ] - }, - { - "group": "Light Clients", - "icon": "plug", - "pages": [ - "concepts/motr", - "concepts/decentralized-auth", - "concepts/identity-generation", - "concepts/dwn-architecture" - ] - }, - { - "group": "Token Economics", - "icon": "coins", - "pages": [ - "concepts/token", - "economics/values", - "economics/utility", - "economics/staking", - "economics/rewards", - "economics/governance", - "economics/distribution" - ] - } - ] - }, - { - "group": "Build Apps", - "icon": "hammer", - "pages": [ - { - "group": "Client SDKs", - "icon": "code", - "pages": [ - "quickstart/react", - "quickstart/browser", - "quickstart/golang" - ] - }, - { - "group": "Service Management", - "icon": "globe", - "pages": [ - "guides/register-records", - "guides/authorize-clients", - "guides/broadcast-transactions", - "guides/issue-payments", - "guides/establish-connection" - ] - } - ] - }, - { - "group": "Validator Guides", - "icon": "shield-check", - "pages": [ - "guides/onboarding", - "guides/development", - "guides/deployment", - { - "group": "Security Report", - "icon": "shield", - "pages": [ - "reference/security/audit-report", - "reference/security/compliance", - "reference/security/cryptography", - "reference/security/vulnerabilities" - ] - } - ] - }, - { - "group": "Next Steps", - "icon": "play", - "pages": [] - } - ] - }, - { - "dropdown": "Reference", - "description": "API Reference", - "icon": "code", - "pages": [ - { - "group": "CLI Commands", - "icon": "terminal", - "root": "cli-commands", - "pages": [ - "reference/commands/snrd", - "reference/commands/snrd_auth", - "reference/commands/snrd_auth_register", - "reference/commands/snrd_genesis", - "reference/commands/snrd_genesis_add-genesis-account", - "reference/commands/snrd_genesis_collect-gentxs", - "reference/commands/snrd_genesis_export", - "reference/commands/snrd_genesis_gentx", - "reference/commands/snrd_genesis_init", - "reference/commands/snrd_genesis_migrate", - "reference/commands/snrd_genesis_validate", - "reference/commands/snrd_help", - "reference/commands/snrd_init", - "reference/commands/snrd_keys", - "reference/commands/snrd_keys_add", - "reference/commands/snrd_keys_delete", - "reference/commands/snrd_keys_export", - "reference/commands/snrd_keys_import", - "reference/commands/snrd_keys_list", - "reference/commands/snrd_keys_migrate", - "reference/commands/snrd_keys_parse", - "reference/commands/snrd_keys_show", - "reference/commands/snrd_migrate", - "reference/commands/snrd_node", - "reference/commands/snrd_prune", - "reference/commands/snrd_query", - "reference/commands/snrd_query_account", - "reference/commands/snrd_query_accounts", - "reference/commands/snrd_query_auth", - "reference/commands/snrd_query_bank", - "reference/commands/snrd_query_consensus", - "reference/commands/snrd_query_delegation", - "reference/commands/snrd_query_did", - "reference/commands/snrd_query_distribution", - "reference/commands/snrd_query_dwn", - "reference/commands/snrd_query_feegrant", - "reference/commands/snrd_query_gov", - "reference/commands/snrd_query_slashing", - "reference/commands/snrd_query_staking", - "reference/commands/snrd_query_svc", - "reference/commands/snrd_query_tendermint", - "reference/commands/snrd_query_tx", - "reference/commands/snrd_rollback", - "reference/commands/snrd_status", - "reference/commands/snrd_tendermint", - "reference/commands/snrd_tx", - "reference/commands/snrd_tx_bank", - "reference/commands/snrd_tx_consensus", - "reference/commands/snrd_tx_crisis", - "reference/commands/snrd_tx_did", - "reference/commands/snrd_tx_distribution", - "reference/commands/snrd_tx_dwn", - "reference/commands/snrd_tx_feegrant", - "reference/commands/snrd_tx_gov", - "reference/commands/snrd_tx_slashing", - "reference/commands/snrd_tx_staking", - "reference/commands/snrd_tx_svc", - "reference/commands/snrd_version" - ] - }, - { - "group": "Decentralized Exchange", - "icon": "arrow-right-left", - "tag": "x/dex", - "pages": [ - { - "group": "HTTP Endpoints", - "tag": "Query", - "icon": "rss", - "pages": [ - "api-reference/dex/get-dex-account", - "api-reference/dex/get-module-parameters", - "api-reference/dex/get-pool-information", - "api-reference/dex/get-remote-chain-balance", - "api-reference/dex/get-transaction-history", - "api-reference/dex/list-all-dex-accounts", - "api-reference/dex/list-orders" - ] - }, - { - "group": "GRPC Methods", - "tag": "TxMsg", - "icon": "plug", - "pages": [ - "api-reference/dex/add-liquidity", - "api-reference/dex/cancel-order", - "api-reference/dex/create-dex-account", - "api-reference/dex/create-limit-order", - "api-reference/dex/execute-token-swap", - "api-reference/dex/remove-liquidity" - ] - } - ] - }, - { - "group": "Decentralized Identifiers", - "icon": "contact-round", - "tag": "x/did", - "pages": [ - { - "group": "HTTP Endpoints", - "tag": "Query", - "icon": "rss", - "pages": [ - "api-reference/did/get-all-credentials-by-did", - "api-reference/did/get-did-document", - "api-reference/did/get-dids-by-controller", - "api-reference/did/get-module-parameters", - "api-reference/did/get-service-endpoint", - "api-reference/did/get-verifiable-credential", - "api-reference/did/get-verification-method", - "api-reference/did/list-all-did-documents", - "api-reference/did/list-verifiable-credentials", - "api-reference/did/resolve-did" - ] - }, - { - "group": "GRPC Methods", - "tag": "TxMsg", - "icon": "plug", - "pages": [ - "api-reference/did/add-service-endpoint", - "api-reference/did/add-verification-method", - "api-reference/did/create-did-document", - "api-reference/did/deactivate-did", - "api-reference/did/issue-verifiable-credential", - "api-reference/did/link-external-wallet", - "api-reference/did/register-webauthn-credential-gasless", - "api-reference/did/remove-service-endpoint", - "api-reference/did/remove-verification-method", - "api-reference/did/revoke-verifiable-credential", - "api-reference/did/update-did-document", - "api-reference/did/update-module-parameters" - ] - } - ] - }, - { - "group": "Decentralized Web Nodes", - "icon": "wallet", - "tag": "x/dwn", - "pages": [ - { - "group": "HTTP Endpoints", - "tag": "Query", - "icon": "rss", - "pages": [ - "api-reference/dwn/query-dwn-permissions", - "api-reference/dwn/query-dwn-protocols", - "api-reference/dwn/query-dwn-records", - "api-reference/dwn/query-encrypted-record-with-decryption", - "api-reference/dwn/query-encryption-system-status", - "api-reference/dwn/query-ipfs-node-status", - "api-reference/dwn/query-module-parameters", - "api-reference/dwn/query-specific-dwn-record", - "api-reference/dwn/query-specific-dwn-protocol", - "api-reference/dwn/query-specific-vault", - "api-reference/dwn/query-vaults-by-owner", - "api-reference/dwn/query-vrf-consensus-contributions", - "api-reference/dwn/retrieve-ipfs-content-by-cid" - ] - }, - { - "group": "GRPC Methods", - "tag": "TxMsg", - "icon": "plug", - "pages": [ - "api-reference/dwn/configure-dwn-protocol", - "api-reference/dwn/delete-record-from-dwn", - "api-reference/dwn/grant-dwn-permission", - "api-reference/dwn/revoke-dwn-permission", - "api-reference/dwn/rotate-vault-encryption-keys", - "api-reference/dwn/update-dwn-module-parameters", - "api-reference/dwn/write-record-to-dwn" - ] - } - ] - }, - { - "group": "Service Registry", - "icon": "shield-check", - "tag": "x/svc", - "pages": [ - { - "group": "HTTP Endpoints", - "tag": "Query", - "icon": "rss", - "pages": [ - "api-reference/svc/query-domain-verification-status", - "api-reference/svc/query-module-parameters", - "api-reference/svc/query-service-by-id", - "api-reference/svc/query-services-by-domain", - "api-reference/svc/query-services-by-owner" - ] - }, - { - "group": "GRPC Methods", - "tag": "TxMsg", - "icon": "plug", - "pages": [ - "api-reference/svc/complete-domain-verification", - "api-reference/svc/initiate-domain-verification", - "api-reference/svc/register-service-with-verified-domain", - "api-reference/svc/update-module-parameters" - ] - } - ] - } - ] - } - ] - }, - "footer": { - "socials": { - "discord": "https://sonr.io/discord", - "github": "https://github.com/sonr-io", - "twitter": "https://twitter.com/sonr_io", - "youtube": "https://youtube.com/@sonrhq", - "website": "https://sonr.io" - } - }, - "integrations": { - "ga4": { - "measurementId": "G-FY0WZBSGH8" - } - } -} diff --git a/docs/faq.mdx b/docs/faq.mdx index 234ec211f..ef220aa51 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -1,10 +1,12 @@ --- title: "Frequently Asked Questions" -sidebarTitle: "FAQ" description: "A Collection of commonly asked questions about Sonr" icon: "life-buoy" +sidebar: + label: "FAQ" --- +