mirror of
https://github.com/onsonr/sonr.git
synced 2025-03-10 13:07:09 +00:00
1 line
57 KiB
JSON
1 line
57 KiB
JSON
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Introduction","text":"<p>Sonr is a decentralized identity network built on the Cosmos-sdk. It has early origins as a peer-to-peer file sharing network, but has since evolved into a platform for decentralized authentication and authorization. The early lessons taught from our file sharing roots are used as our theology for building the Sonr Blockchain.</p> <ol> <li>Cosmos-SDK</li> <li>Chain-Modules</li> <li>System-Architecture</li> <li>Token-Economy</li> <li>Service-Management</li> <li>Design-System</li> <li>Self-Custody</li> <li>Consumer Launch</li> </ol>"},{"location":"#principles","title":"Principles","text":"<ol> <li>Bitcoin is digital gold</li> <li>Blockchains are programmable databases with functional operations</li> <li>Staking is essentially a savings account</li> <li>The Sonr Network conducts all operations in the $SNR token</li> <li>Service Delegation subsidizes user wallet operations.</li> <li>Cryptocurrency has the potential to break the software innovation ceiling</li> </ol>"},{"location":"#the-problem","title":"The Problem","text":"<p>Centralized identity has led to internet monopolies abusing your trust and privacy.</p>"},{"location":"#the-solution","title":"The Solution","text":"<p>A peer-to-peer system for decentralized personal identity with Authentication and Authorization capabilities.</p>"},{"location":"#what-is-sonr","title":"What is Sonr?","text":"<p>A privacy preserving, identity system managed by user controlled decentralized vaults which have the flexibility of software wallets with the security of hardware wallets.</p>"},{"location":"#the-end-goal","title":"The End Goal","text":"<p>A Data sharing economy where human-specific information has intrinsic value. Services are incentivized to act in good faith in order to obtain quality user data.</p>"},{"location":"#how-do-we-do-it","title":"How do we do it?","text":"<p>Provide Internet Citizens with a robust easy to use WebVault which features a crypto wallet, passkey authenticator, and encrypted messages. The WebVault serves as a wrapper over every sensitive intent-based user interaction. The Smart blockchain is responsible for keeping a record of where WebVaults are located, when authorization activity occurs, and which services are allowed over what permissions.</p>"},{"location":"#the-user-incentive","title":"The User Incentive","text":"<p>Data is the byproduct of currency exchange in the Information age. Meaning services pay other services for user data or profits in order to enrich their database with complete user personas.</p>"},{"location":"changelog/","title":"Index","text":""},{"location":"changelog/#v0526-2024-12-13","title":"v0.5.26 (2024-12-13)","text":""},{"location":"changelog/#fix","title":"Fix","text":"<ul> <li>Correct regular expression for version tags in release workflow</li> </ul>"},{"location":"changelog/#v0525-2024-12-11","title":"v0.5.25 (2024-12-11)","text":""},{"location":"changelog/#feat","title":"Feat","text":"<ul> <li>enable GoReleaser releases on tags and snapshots</li> <li>automate release on tag and workflow dispatch</li> </ul>"},{"location":"changelog/#v0524-2024-12-11","title":"v0.5.24 (2024-12-11)","text":""},{"location":"changelog/#feat_1","title":"Feat","text":"<ul> <li>prevent duplicate releases</li> </ul>"},{"location":"changelog/#v0523-2024-12-11","title":"v0.5.23 (2024-12-11)","text":""},{"location":"changelog/#refactor","title":"Refactor","text":"<ul> <li>rename scheduled release workflow to versioned release</li> <li>remove changelog from release artifacts</li> </ul>"},{"location":"changelog/#v0522-2024-12-11","title":"v0.5.22 (2024-12-11)","text":""},{"location":"changelog/#feat_2","title":"Feat","text":"<ul> <li>Implement passkey-based authentication and registration flow</li> </ul>"},{"location":"changelog/#v0521-2024-12-11","title":"v0.5.21 (2024-12-11)","text":""},{"location":"changelog/#feat_3","title":"Feat","text":"<ul> <li>allow manual triggering of deployment workflow</li> <li>add start-tui command for interactive mode</li> <li>add coin selection and update passkey input in registration form</li> <li>add hway command for Sonr DID gateway</li> <li>Conditionally install process-compose only if binary not found</li> <li>Add process-compose support with custom start and down commands</li> <li>implement passkey registration flow</li> <li>Improve createProfile form layout with wider max-width and enhanced spacing</li> <li>improve index page UI with new navigation buttons and remove redundant settings buttons</li> <li>Make input rows responsive with grid layout for mobile and desktop</li> <li>enhance index page with additional settings buttons and style adjustments</li> <li>implement passkey-based authentication</li> <li>add support for Cloudsmith releases</li> <li>add go dependency and enhance devbox environment variables</li> <li>update create profile form placeholders and handle</li> <li>add DID-based authentication middleware</li> <li>Add validation for human verification slider sum in CreateProfile form</li> <li>implement passkey registration flow</li> <li>Update WebAuthn credential handling with modern browser standards</li> <li>Streamline passkey registration with automatic form submission</li> <li>Add credential parsing and logging in register finish handler</li> <li>Add credential details row with icon after passkey creation</li> <li>Add form validation for passkey credential input</li> <li>implement passkey registration flow</li> <li>Add hidden input to store passkey credential data for form submission</li> <li>add CI workflow for deploying network</li> <li>add hway binary support and Homebrew formula</li> <li>remove username from passkey creation</li> <li>implement passkey registration flow</li> <li>add passkey creation functionality</li> <li>add CNAME for onsonr.dev domain</li> </ul>"},{"location":"changelog/#fix_1","title":"Fix","text":"<ul> <li>use Unix domain sockets for devnet processes</li> <li>correct workflow name and improve devnet deployment process</li> <li>correct title of profile creation page</li> <li>rename devbox start script to up and remove stop script</li> <li>Consolidate archive configuration and add LICENSE file</li> <li>Improve cross-browser passkey credential handling and encoding</li> <li>Remove commented-out code in passkey registration script</li> <li>remove line-clamp from tailwind config</li> <li>remove unnecessary background and restart settings from process-compose.yaml</li> <li>suppress process-compose server output and log to file</li> </ul>"},{"location":"changelog/#refactor_1","title":"Refactor","text":"<ul> <li>remove unnecessary git fetch step in deploy workflow</li> <li>remove obsolete interchain test dependencies</li> <li>update index views to use new nebula components</li> <li>move Wasm related code to pkg/common/wasm</li> <li>migrate config package to pkg directory</li> <li>migrate to new configuration system and model definitions</li> <li>move session package to pkg directory</li> <li>Refactor registration forms to use UI components</li> <li>move gateway config to vault package</li> <li>improve command line flag descriptions and variable names</li> <li>refactor hway command to use echo framework for server</li> <li>Update root command to load EnvImpl from cobra flags</li> <li>Modify command flags and environment loading logic in cmds.go</li> <li>improve build process and move process-compose.yaml</li> <li>remove unused devbox.json and related configurations</li> <li>Improve mobile layout responsiveness for Rows and Columns components</li> <li>Remove max-w-fit from Rows component</li> <li>replace session package with context package</li> <li>rename database initialization function</li> <li>move session management to dedicated database module</li> <li>remove unused UI components related to wallet and index pages</li> <li>consolidate handlers into single files</li> <li>move gateway and vault packages to internal directory</li> <li>Move registration form components to dedicated directory</li> <li>remove unused devbox package</li> <li>remove devbox configuration</li> <li>move vault package to app directory</li> <li>improve code structure within gateway package</li> <li>move gateway package to app directory</li> <li>move vault package internal components to root</li> <li>migrate layout imports to common styles package</li> <li>Move form templates and styles to common directory</li> <li>consolidate authentication and DID handling logic</li> <li>Improve WebAuthn credential handling and validation in register finish route</li> <li>remove profile card component</li> <li>Simplify passkey registration UI and move profile component inline</li> <li>Update credential logging with transport and ID type</li> <li>Update register handler to use protocol.CredentialDescriptor struct</li> <li>Update credential handling to use protocol.CredentialDescriptor</li> <li>improve profile card styling and functionality</li> <li>Simplify session management and browser information extraction</li> <li>Update PeerInfo to extract and store comprehensive device information</li> <li>improve address display in property details</li> <li>remove unused documentation generation script</li> <li>replace sonr/pkg/styles/layout with nebula/ui/layout</li> <li>migrate UI components to nebula module</li> <li>improve scopes.json structure and update scripts for better usability</li> </ul>"},{"location":"changelog/#v0520-2024-12-07","title":"v0.5.20 (2024-12-07)","text":""},{"location":"changelog/#refactor_2","title":"Refactor","text":"<ul> <li>simplify CI workflow by removing redundant asset publishing steps</li> </ul>"},{"location":"changelog/#v0519-2024-12-06","title":"v0.5.19 (2024-12-06)","text":""},{"location":"changelog/#feat_4","title":"Feat","text":"<ul> <li>add support for parent field and resources list in Capability message</li> <li>add fast reflection methods for Capability and Resource</li> <li>add gum package and update devbox configuration</li> <li>add new button components and layout improvements</li> </ul>"},{"location":"changelog/#fix_2","title":"Fix","text":"<ul> <li>adjust fullscreen modal close button margin</li> <li>update devbox lockfile</li> <li>resolve rendering issue in login modal</li> </ul>"},{"location":"changelog/#refactor_3","title":"Refactor","text":"<ul> <li>rename accaddr package to address</li> <li>Update Credential table to match WebAuthn Credential Descriptor</li> <li>Deployment setup</li> <li>migrate build system from Taskfile to Makefile</li> <li>rename Assertion to Account and update related code</li> <li>remove unused TUI components</li> <li>Move IPFS interaction functions to common package</li> <li>remove dependency on DWN.pkl</li> <li>remove unused dependencies and simplify module imports</li> <li>Rename x/vault -> x/dwn and x/service -> x/svc</li> <li>move resolver formatter to services package</li> <li>remove web documentation</li> <li>update devbox configuration and scripts</li> <li>rename layout component to root</li> <li>refactor authentication pages into their own modules</li> <li>update templ version to v0.2.778 and remove unused air config</li> <li>move signer implementation to mpc package</li> </ul>"},{"location":"changelog/#v0518-2024-11-06","title":"v0.5.18 (2024-11-06)","text":""},{"location":"changelog/#v0517-2024-11-05","title":"v0.5.17 (2024-11-05)","text":""},{"location":"changelog/#feat_5","title":"Feat","text":"<ul> <li>add remote client constructor</li> <li>add avatar image components</li> <li>add SVG CDN Illustrations to marketing architecture</li> <li>marketing: refactor marketing page components</li> <li>Refactor intro video component to use a proper script template</li> <li>Move Alpine.js script initialization to separate component</li> <li>Add intro video modal component</li> <li>add homepage architecture section</li> <li>add Hero section component with stats and buttons</li> <li>css: add new utility classes for group hover</li> <li>implement authentication register finish endpoint</li> <li>add controller creation step to allocate</li> <li>Update service module README based on protobuf files</li> <li>Update x/macaroon/README.md with details from protobuf files</li> <li>update Vault README with details from proto files</li> </ul>"},{"location":"changelog/#fix_3","title":"Fix","text":"<ul> <li>update file paths in error messages</li> <li>update intro video modal script</li> <li>include assets generation in wasm build</li> </ul>"},{"location":"changelog/#refactor_4","title":"Refactor","text":"<ul> <li>update marketing section architecture</li> <li>change verification table id</li> <li>proto: remove macaroon proto</li> <li>rename ValidateBasic to Validate</li> <li>rename session cookie key</li> <li>remove unused sync-initial endpoint</li> <li>remove formatter.go from service module</li> </ul>"},{"location":"changelog/#v0516-2024-10-21","title":"v0.5.16 (2024-10-21)","text":""},{"location":"changelog/#v0515-2024-10-21","title":"v0.5.15 (2024-10-21)","text":""},{"location":"changelog/#v0514-2024-10-21","title":"v0.5.14 (2024-10-21)","text":""},{"location":"changelog/#refactor_5","title":"Refactor","text":"<ul> <li>remove StakingKeeper dependency from GlobalFeeDecorator</li> </ul>"},{"location":"changelog/#v0513-2024-10-21","title":"v0.5.13 (2024-10-21)","text":""},{"location":"changelog/#feat_6","title":"Feat","text":"<ul> <li>add custom secp256k1 pubkey</li> </ul>"},{"location":"changelog/#refactor_6","title":"Refactor","text":"<ul> <li>update gRPC client to use new request types</li> <li>use RawPublicKey instead of PublicKey in macaroon issuer</li> <li>improve error handling in DID module</li> </ul>"},{"location":"changelog/#v0512-2024-10-18","title":"v0.5.12 (2024-10-18)","text":""},{"location":"changelog/#feat_7","title":"Feat","text":"<ul> <li>add User-Agent and Platform to session</li> <li>introduce AuthState enum for authentication state</li> </ul>"},{"location":"changelog/#fix_4","title":"Fix","text":"<ul> <li>version: revert version bump to 0.5.11</li> <li>version: update version to 0.5.12</li> </ul>"},{"location":"changelog/#refactor_7","title":"Refactor","text":"<ul> <li>remove dependency on proto change detection</li> <li>update asset publishing configuration</li> </ul>"},{"location":"changelog/#v0511-2024-10-10","title":"v0.5.11 (2024-10-10)","text":""},{"location":"changelog/#feat_8","title":"Feat","text":"<ul> <li>nebula assets served from CDN</li> <li>use CDN for nebula frontend assets</li> <li>add static hero section content to homepage</li> <li>add wrangler scripts for development, build, and deployment</li> <li>remove build configuration</li> <li>move gateway web code to dedicated directory</li> <li>add PubKey fast reflection</li> <li>macaroon: add transaction allowlist/denylist caveats</li> <li>add PR labeler</li> <li>devbox: remove hway start command</li> <li>add GitHub Actions workflow for running tests</li> <li>add workflow for deploying Hway to Cloudflare Workers</li> <li>Publish configs to R2</li> <li>integrate nebula UI with worker-assets-gen</li> <li>extract reusable layout components</li> <li>Implement service worker for IPFS vault</li> <li>implement CDN support for assets</li> <li>add payment method support</li> <li>add support for public key management</li> <li>add ModalForm component</li> <li>add LoginStart and RegisterStart routes</li> <li>implement authentication views</li> <li>add json tags to config structs</li> <li>implement templ forms for consent privacy, credential assert, credential register, and profile details</li> <li>vault: introduce assembly of the initial vault</li> <li>add client logos to homepage</li> <li>add tailwind utility classes</li> <li>implement new profile card component</li> </ul>"},{"location":"changelog/#fix_5","title":"Fix","text":"<ul> <li>Correct source directory for asset publishing</li> <li>install dependencies before nebula build</li> <li>update Schema service to use new API endpoint</li> <li>fix broken logo image path</li> </ul>"},{"location":"changelog/#refactor_8","title":"Refactor","text":"<ul> <li>remove unnecessary branch configuration from scheduled release workflow</li> <li>update dwn configuration generation import path</li> <li>use nebula/routes instead of nebula/global</li> <li>move index template to routes package</li> <li>remove cdn package and move assets to global styles</li> <li>move nebula assets to hway build directory</li> <li>remove docker build and deployment</li> <li>rename internal/session package to internal/ctx</li> <li>remove unused fields from</li> <li>rename PR_TEMPLATE to PULL_REQUEST_TEMPLATE</li> <li>remove devbox.json init hook</li> <li>rename sonrd dockerfile to Dockerfile</li> <li>remove unused dependency</li> <li>rename 'global/cdn' to 'assets'</li> <li>move CDN assets to separate folder</li> <li>move Pkl module definitions to dedicated package</li> <li>move CDN assets to js/ folder</li> <li>remove unused component templates</li> <li>move ui components to global</li> <li>move view handlers to router package</li> </ul>"},{"location":"changelog/#v0510-2024-10-07","title":"v0.5.10 (2024-10-07)","text":""},{"location":"changelog/#feat_9","title":"Feat","text":"<ul> <li>blocks: remove button component</li> </ul>"},{"location":"changelog/#v059-2024-10-06","title":"v0.5.9 (2024-10-06)","text":""},{"location":"changelog/#feat_10","title":"Feat","text":"<ul> <li>add Motr support</li> <li>update UIUX PKL to utilize optional fields</li> </ul>"},{"location":"changelog/#fix_6","title":"Fix","text":"<ul> <li>Update source directory for asset publishing</li> </ul>"},{"location":"changelog/#v058-2024-10-04","title":"v0.5.8 (2024-10-04)","text":""},{"location":"changelog/#refactor_9","title":"Refactor","text":"<ul> <li>Remove unused logs configuration</li> </ul>"},{"location":"changelog/#v057-2024-10-04","title":"v0.5.7 (2024-10-04)","text":""},{"location":"changelog/#feat_11","title":"Feat","text":"<ul> <li>devbox: use process-compose for testnet services</li> <li>remove motr.mjs dependency</li> <li>add markdown rendering to issue templates</li> <li>update issue templates for better clarity</li> <li>add issue templates for tracking and task issues</li> <li>add issue templates for bug report and tracking</li> <li>introduce docker-compose based setup</li> </ul>"},{"location":"changelog/#refactor_10","title":"Refactor","text":"<ul> <li>update issue template headings</li> <li>rename bug-report issue template to bug</li> </ul>"},{"location":"changelog/#v056-2024-10-03","title":"v0.5.6 (2024-10-03)","text":""},{"location":"changelog/#feat_12","title":"Feat","text":"<ul> <li>add hway and sonr processes to dev environment</li> </ul>"},{"location":"changelog/#v055-2024-10-03","title":"v0.5.5 (2024-10-03)","text":""},{"location":"changelog/#feat_13","title":"Feat","text":"<ul> <li>add rudimentary DidController table</li> <li>update home section with new features</li> <li>introduce Home model and refactor views</li> <li>nebula: create Home model for home page</li> </ul>"},{"location":"changelog/#refactor_11","title":"Refactor","text":"<ul> <li>reorganize pkl files for better separation of concerns</li> <li>rename msg_server_test.go to rpc_test.go</li> </ul>"},{"location":"changelog/#v054-2024-10-02","title":"v0.5.4 (2024-10-02)","text":""},{"location":"changelog/#v053-2024-10-02","title":"v0.5.3 (2024-10-02)","text":""},{"location":"changelog/#fix_7","title":"Fix","text":"<ul> <li>remove unnecessary telegram message template</li> </ul>"},{"location":"changelog/#v052-2024-10-02","title":"v0.5.2 (2024-10-02)","text":""},{"location":"changelog/#feat_14","title":"Feat","text":"<ul> <li>service: integrate group module (#1104)</li> </ul>"},{"location":"changelog/#refactor_12","title":"Refactor","text":"<ul> <li>revert version bump to 0.5.1</li> </ul>"},{"location":"changelog/#v051-2024-10-02","title":"v0.5.1 (2024-10-02)","text":""},{"location":"changelog/#refactor_13","title":"Refactor","text":"<ul> <li>move Motr API to state package</li> </ul>"},{"location":"changelog/#v050-2024-10-02","title":"v0.5.0 (2024-10-02)","text":""},{"location":"changelog/#feat_15","title":"Feat","text":"<ul> <li>allow multiple macaroons with the same id</li> </ul>"},{"location":"changelog/#v045-2024-10-02","title":"v0.4.5 (2024-10-02)","text":""},{"location":"changelog/#fix_8","title":"Fix","text":"<ul> <li>use correct secret for docker login</li> </ul>"},{"location":"changelog/#v044-2024-10-02","title":"v0.4.4 (2024-10-02)","text":""},{"location":"changelog/#v043-2024-10-02","title":"v0.4.3 (2024-10-02)","text":""},{"location":"changelog/#feat_16","title":"Feat","text":"<ul> <li>release: add docker images for sonrd and motr</li> <li>update homepage with new visual design</li> <li>add DID to vault genesis schema</li> <li>add video component</li> <li>add video component</li> <li>add hx-get attribute to primary button in hero section</li> </ul>"},{"location":"changelog/#fix_9","title":"Fix","text":"<ul> <li>layout: add missing favicon</li> <li>hero: Use hx-swap for primary button to prevent flicker</li> </ul>"},{"location":"changelog/#refactor_14","title":"Refactor","text":"<ul> <li>use single GITHUB_TOKEN for release workflow</li> <li>update workflow variables</li> </ul>"},{"location":"changelog/#v042-2024-10-01","title":"v0.4.2 (2024-10-01)","text":""},{"location":"changelog/#refactor_15","title":"Refactor","text":"<ul> <li>use single GITHUB_TOKEN for release workflow</li> </ul>"},{"location":"changelog/#v041-2024-10-01","title":"v0.4.1 (2024-10-01)","text":""},{"location":"changelog/#feat_17","title":"Feat","text":"<ul> <li>Implement session management</li> <li>allow manual release triggers</li> <li>add Input and RegistrationForm models</li> <li>add new utility classes</li> <li>add login and registration pages</li> <li>add tailwindcss utilities</li> <li>add support for ARM64 architecture</li> <li>add DWN resolver field</li> <li>add stats section to homepage</li> <li>implement hero section using Pkl</li> <li>add PKL schema for message formats</li> <li>add Homebrew tap for sonr</li> <li>update release workflow to use latest tag</li> </ul>"},{"location":"changelog/#fix_10","title":"Fix","text":"<ul> <li>version: update version number to 0.4.0</li> <li>update release workflow to use latest tag</li> <li>versioning: revert version to 0.9.0</li> <li>cta: Fix typo in CTA title</li> <li>change bento section title to reflect security focus</li> <li>adjust hero image dimensions</li> <li>Input: Change type from to</li> <li>update hero image height in config.pkl</li> </ul>"},{"location":"changelog/#refactor_16","title":"Refactor","text":"<ul> <li>move home page sections to home package</li> <li>rename motrd to motr</li> <li>update hero image dimensions</li> <li>move nebula configuration to static file</li> <li>rename buf-publish.yml to publish-assets.yml</li> <li>remove unused field from</li> </ul>"},{"location":"changelog/#v040-2024-09-30","title":"v0.4.0 (2024-09-30)","text":""},{"location":"changelog/#feat_18","title":"Feat","text":"<ul> <li>dwn: add wasm build for dwn</li> <li>add macaroon and oracle genesis states</li> <li>add scheduled binary release workflow</li> <li>introduce process-compose for process management</li> <li>add counter animation to hero section</li> <li>add registration page</li> </ul>"},{"location":"changelog/#fix_11","title":"Fix","text":"<ul> <li>Enable scheduled release workflow</li> </ul>"},{"location":"changelog/#refactor_17","title":"Refactor","text":"<ul> <li>remove old changelog entries</li> <li>remove unnecessary checkout in scheduled-release workflow</li> <li>rename build ID to sonr</li> <li>remove unnecessary release existence check</li> <li>move dwn wasm build to pkg directory</li> </ul>"},{"location":"changelog/#v031-2024-09-29","title":"v0.3.1 (2024-09-29)","text":""},{"location":"changelog/#refactor_18","title":"Refactor","text":"<ul> <li>move nebula/pages to pkg/nebula/pages</li> </ul>"},{"location":"changelog/#v030-2024-09-29","title":"v0.3.0 (2024-09-29)","text":""},{"location":"changelog/#feat_19","title":"Feat","text":"<ul> <li>add buf.lock for proto definitions</li> </ul>"},{"location":"changelog/#fix_12","title":"Fix","text":"<ul> <li>remove unused linting rules</li> <li>update proto breaking check target to master branch</li> </ul>"},{"location":"changelog/#refactor_19","title":"Refactor","text":"<ul> <li>remove unused lock files and configurations</li> </ul>"},{"location":"changelog/#v020-2024-09-29","title":"v0.2.0 (2024-09-29)","text":""},{"location":"changelog/#feat_20","title":"Feat","text":"<ul> <li>disable goreleaser workflow</li> <li>update workflows to include master branch</li> <li>remove global style declaration</li> <li>oracle: add oracle module</li> <li>optimize IPFS configuration for better performance</li> <li>add local IPFS bootstrap script and refactor devbox config</li> <li>add AllocateVault HTTP endpoint</li> <li>add WebAuthn credential management functionality</li> <li>remove unused coins interface</li> <li>remove global integrity proof from genesis state</li> <li>add vault module</li> <li>enable buf.build publishing on master and develop branches</li> <li>add Gitflow workflow for syncing branches</li> <li>add automated production release workflow</li> <li>ui: implement profile page</li> <li>add automated production release workflow</li> <li>did: remove unused proto files</li> <li>add enums.pulsar.go file for PermissionScope enum (#4)</li> <li>add initial DID implementation</li> <li>remove builder interface</li> <li>add basic UI for block explorer</li> <li>add Usage: pkl [OPTIONS] COMMAND [ARGS]...</li> <li>use SQLite embedded driver</li> <li>add DID method for each coin</li> <li>Expand KeyType enum and update KeyInfo message in genesis.proto</li> <li>Add whitelisted key types to genesis params</li> <li>Add DID grants protobuf definition</li> <li>Add fields to KeyInfo struct to distinguish CBOR and standard blockchain key types</li> <li>Add new message types for AssetInfo, ChainInfo, Endpoint, ExplorerInfo, FeeInfo, and KeyInfo</li> <li>run sonr-node container in testnet network and make network external</li> <li>Add docker-compose.yaml file to start a Sonr testnet node</li> <li>configure Sonr testnet environment</li> <li>Update Dockerfile to start and run a testnet</li> <li>add Equal methods for AssetInfo and ChainInfo types</li> <li>Add ProveWitness and SyncVault RPCs</li> <li>Add MsgRegisterService to handle service registration</li> <li>Add MsgRegisterService to handle service registration</li> <li>add enums.pulsar.go file for PermissionScope enum</li> </ul>"},{"location":"changelog/#fix_13","title":"Fix","text":"<ul> <li>ensure go version is up-to-date</li> <li>use GITHUB_TOKEN for version bump workflow</li> <li>update account table interface to use address, chain and network</li> <li>ci: update docker vm release workflow with new token</li> <li>use mnemonic phrases for test account keys</li> <li>reduce motr proxy shutdown timeout</li> <li>nebula: use bunx for tailwindcss build</li> <li>proto: update protobuf message index numbers</li> <li>ante: reduce POA rate floor and ceiling</li> <li>Update proc_list_width in mprocs.yaml</li> <li>Add service to database when registering</li> <li>pin added did documents to local ipfs node</li> <li>remove extra spaces in typeUrl</li> <li>release: remove unnecessary quotes in tag pattern</li> <li>remove unused imports and simplify KeyInfo message</li> <li>bind node ports to localhost</li> <li>Update docker-compose network name to dokploy-network</li> <li>Update network name to dokploy</li> <li>remove unused port mapping</li> <li>Update docker-compose.yaml to use correct volume path</li> <li>update docker-compose volume name</li> <li>Update docker-compose.yaml to use shell directly for sonrd command</li> <li>replace \"sh\" with \"/bin/sh\" in docker-compose.yaml command</li> <li>Update runner image dependencies for debian-11</li> <li>deps: update golang image to 1.21</li> <li>chains: update nomic chain build target</li> <li>Remove unused <code>Meta</code> message from <code>genesis.proto</code></li> <li>Add ProveWitness and SyncVault RPCs</li> </ul>"},{"location":"changelog/#refactor_20","title":"Refactor","text":"<ul> <li>adjust source directory for config files (#1102)</li> <li>Use actions/checkout@v4</li> <li>remove unused master branch from CI workflow</li> <li>rename github token secret</li> <li>remove unnecessary x-cloak styles</li> <li>optimize oracle genesis proto</li> <li>remove unused code related to whitelisted assets</li> <li>update buf publish source directory</li> <li>adjust devbox configuration to reflect nebula changes</li> <li>rename msg_server.go to rpc.go</li> <li>remove devbox integration</li> <li>move dwn package to app/config</li> <li>move configuration files to app directory</li> <li>extract root command creation to separate file</li> <li>move ipfs setup to function</li> <li>remove unnecessary proxy config</li> <li>rename script to</li> <li>move DWN proxy server logic to separate file</li> <li>use htmx instead of dwn for vault client</li> <li>remove unused environment variables</li> <li>simplify verification method structure</li> <li>use staking keeper in DID keeper</li> <li>remove unused dependencies</li> <li>remove unused image building workflow</li> <li>add field to</li> <li>Update KeyKind Enum to have proper naming conventions</li> <li>Update <code>DIDNamespace</code> to have proper naming convention</li> <li>expose ports directly in docker-compose</li> <li>remove unused port mappings</li> <li>streamline script execution</li> <li>use CMD instead of ENTRYPOINT in Dockerfile</li> <li>deps: Upgrade Debian base image to 11</li> <li>Simplify the types and properties to keep a consistent structure for the blockchain</li> <li>remove PERMISSION_SCOPE_IDENTIFIERS_ENS enum value</li> </ul>"},{"location":"concepts/Chain-Modules/","title":"Chain Modules","text":""},{"location":"concepts/Chain-Modules/#xdid-auth-authz","title":"<code>x/did</code> - Auth & AuthZ","text":"<p>The DID module is responsible for managing the creation and management of DIDs. Controllers represent on-chain accounts backed by a MPC keypair. Controllers provide methods for Wallet Account Abstraction (WAA) and are responsible for managing the creation and management of DIDs for an individual user.</p>"},{"location":"concepts/Chain-Modules/#features","title":"Features","text":"<ul> <li>DID Controllers leverage the Cosmos SDK's <code>x/accounts</code> std interface for WAA.</li> <li>DIDs are represented by a <code>x/did</code> controller and are required to state the controller's public key, and which map to the controller's capabilities.</li> <li>General Sign/Verify methods are provides from the QueryServer for HTTP requests.</li> <li>The Execute method is used to broadcast transactions across the network. (TODO)</li> <li>Biscuits are used to authenticate and authorize requests between services. (TODO)</li> </ul>"},{"location":"concepts/Chain-Modules/#references","title":"References","text":"<ul> <li>State</li> <li>State Transitions</li> <li>Messages</li> <li>Queries</li> <li>Params</li> <li>Client</li> <li>Future Improvements</li> <li>Tests</li> <li>Appendix</li> </ul>"},{"location":"concepts/Chain-Modules/#xmacaroon","title":"<code>x/macaroon</code>","text":"<p>The macaroon module is responsible for issuing and verifying macaroons. Macaroons are used to authenticate and authorize requests between services. Macaroons are requested by NFT Records from <code>x/service</code> and granted by controllers from <code>x/did</code></p>"},{"location":"concepts/Chain-Modules/#features_1","title":"Features","text":"<ul> <li>On Controller creation, a macaroon is created with an admin scope and a default expiry of 315,569,520 blocks (or ~10 years).</li> <li>On Service registration, a macaroon is created with a service scope and a default expiry of 31,556,952 blocks (or ~1 year).</li> <li>Macaroons contain the scope of access for a service and the expiry of the permissions in <code>blockHeight</code>.</li> </ul>"},{"location":"concepts/Chain-Modules/#references_1","title":"References","text":"<ul> <li>State</li> <li>State Transitions</li> <li>Messages</li> <li>Queries</li> <li>Params</li> <li>Client</li> <li>Future Improvements</li> <li>Tests</li> <li>Appendix</li> </ul>"},{"location":"concepts/Chain-Modules/#xservice","title":"<code>x/service</code>","text":"<p>The service module is responsible for managing decentralized services. Services on the Sonr network are essentially on-chain MultiSig wallets that are represented by a NFT. Service admins are represented by a <code>x/did</code> controller and are required to state the service's scope of access, and which map to the services' capabilities.</p>"},{"location":"concepts/Chain-Modules/#features_2","title":"Features","text":"<ul> <li>Needs a Valid Domain with .htaccess file to be whitelisted.</li> </ul>"},{"location":"concepts/Chain-Modules/#references_2","title":"References","text":"<ul> <li>State</li> <li>State Transitions</li> <li>Messages</li> <li>Queries</li> <li>Params</li> <li>Client</li> <li>Future Improvements</li> <li>Tests</li> <li>Appendix</li> </ul>"},{"location":"concepts/Chain-Modules/#xvault","title":"<code>x/vault</code>","text":"<p>The vault module is responsible for managing the storage and acccess-control of Decentralized Web Nodes (DWNs) from IPFS. Vaults contain user-facing keys and are represented by a <code>x/did</code> controller.</p>"},{"location":"concepts/Chain-Modules/#features_3","title":"Features","text":"<ul> <li>Vaults can be created by anyone, but efforts are made to restrict 1 per user.</li> <li>Vaults are stored in IPFS and when claimed, the bech32 Sonr Address is pinned to IPFS.</li> </ul>"},{"location":"concepts/Chain-Modules/#references_3","title":"References","text":"<ul> <li>State</li> <li>State Transitions</li> <li>Messages</li> <li>Queries</li> <li>Params</li> <li>Client</li> <li>Future Improvements</li> <li>Tests</li> <li>Appendix</li> </ul>"},{"location":"concepts/Consumer-Launch/","title":"Consumer Chain Launch Process","text":"<p>This guide is intended for consumer chain teams that are looking to be onboarded on to the Interchain Security testnet.</p>"},{"location":"concepts/Consumer-Launch/#interchain-security-testnet-overview","title":"Interchain Security Testnet Overview","text":"<ul> <li>The Interchain Security (ICS) testnet is to be used to launch and test consumer chains. We recommend consumer chains to launch on the testnet before launching on the mainnet.</li> <li>All information about the ICS testnet is available in this repository.</li> <li>The testnet coordinators (Hypha) have majority voting power in the ICS testnet. This means we need to work with you to bring your chain live and also to successfully pass any governance proposals you make.</li> </ul>"},{"location":"concepts/Consumer-Launch/#chain-onboarding-process","title":"Chain Onboarding Process","text":"<p>For teams looking to join the ICS testnet, the onboarding process can be broken down in four phases:</p> <ul> <li>Testing and Integration</li> <li>Planning with Testnet Coordinators</li> <li>Proposal Submission</li> <li>Chain Launch</li> </ul>"},{"location":"concepts/Consumer-Launch/#local-testing-and-integration","title":"Local Testing and Integration","text":"<p>During this phase, your team will run integration tests with the following elements of an Interchain Security testnet:</p> <ul> <li>Gaia provider chain</li> <li>Visit the provider chain page for details on which Gaia version is currently being used.</li> <li>Relayers</li> <li>You will be responsible for running the relayer that relays the first set of Validator Set Change packets between provider and consumer chain. You should be proficient in setting up and running either Hermes or rly.</li> </ul> <p>By the end of this phase, you are able to launch a consumer chain within a local testnet or CI workflow that resembles the testnet (or mainnet) environment.</p>"},{"location":"concepts/Consumer-Launch/#planning-with-testnet-coordinators","title":"Planning with Testnet Coordinators","text":"<p>Once you have a binary release ready, you can begin planning the launch with the testnet coordinators (Hypha).</p> <p>The goals of this phase are to update this repository with all the information validators need to join the network and to produce a <code>consumer-addition</code> proposal to be submitted in the provider chain.</p> <p>We expect you to run the minimum infrastructure required to make your consumer chain usable by testnet participants. This means running:</p> <ol> <li>Seed/persistent nodes</li> <li>Relayer it must be launched before the chain times out, preferably right after blocks start being produced.</li> <li>IMPORTANT: Make sure you have funds to pay gas fees for the relayer. You will likely need to set up an adequately funded genesis account for this purpose.</li> </ol> <p>Additionally, you may want to run:</p> <ul> <li>a faucet such as this simple REST faucet (it may need a separate funded account in the genesis file as well)</li> <li>a block explorer such as ping.pub</li> </ul>"},{"location":"concepts/Consumer-Launch/#submitting-a-pr-for-a-new-chain","title":"\u270d\ufe0f Submitting a PR for a new chain","text":"<p>Each consumer chain gets its own directory. You can use the <code>slasher</code> chain as reference. Feel free to clone the slasher directory, modify it for your consumer chain, and make a PR with the relevant information.</p> <p>Hypha will be reviewing the PR to ensure it meets the following criteria:</p>"},{"location":"concepts/Consumer-Launch/#readme-includes","title":"README includes:","text":"<ul> <li>[ ] Consumer chain repo and release or tag name.</li> <li>[ ] Build instructions for chain binary.</li> <li>[ ] Checksum of genesis file without CCV.</li> <li>[ ] Checksum of reference binary.</li> <li>[ ] Instructions on to join</li> <li>[ ] Installation steps</li> <li>Endpoints</li> <li>[ ] Seeds OR persistent peers</li> <li>[ ] State sync nodes (if any)</li> </ul> <p>See the <code>slasher</code> chain page for reference.</p>"},{"location":"concepts/Consumer-Launch/#chain_id-must-be-identical-in-the-following-places","title":"<code>chain_id</code> must be identical in the following places:","text":"<ul> <li>[ ] <code>README</code></li> <li>[ ] genesis file</li> <li>[ ] consumer addition proposal</li> <li>[ ] bash script</li> </ul> <p>We recommend choosing a <code>chain_id</code> with the suffix <code>-1</code>, even if it's a subsequent test of the same chain, e.g. <code>testchain-second-rehearsal-1</code>.</p>"},{"location":"concepts/Consumer-Launch/#binary-checksum-validation","title":"Binary checksum validation","text":"<ul> <li>[ ] <code>shasum -a 256 <binary></code> matches the checksum in the proposal</li> <li>[ ] <code>shasum -a 256 <binary></code> matches <code>README</code></li> </ul>"},{"location":"concepts/Consumer-Launch/#bash-script","title":"Bash script","text":"<ul> <li>[ ] version built in script must match <code>README</code></li> <li>[ ] seeds or persistent peers must match <code>README</code></li> </ul>"},{"location":"concepts/Consumer-Launch/#genesis-file","title":"Genesis file","text":"<ul> <li>[ ] Genesis time must match spawn time in the <code>consumer-addition</code> proposal</li> <li>[ ] Accounts and balances: Properly funded accounts (e.g., gas fees for relayer, faucet, etc.)</li> <li>[ ] Bank balance denom matches denom in <code>README</code></li> <li>[ ] Slashing parameters: Set <code>signed_blocks_window</code> and <code>min_signed_per_window</code> adequately to ensure validators have at least 12 hours to join the chain after launch without getting jailed</li> <li>[ ] <code>shasum -a 256 <genesis file without CCV></code> matches the checksum in the proposal</li> <li>[ ] <code>shasum -a 256 <genesis file without CCV></code> matches the checksum in the <code>README</code></li> <li>[ ] The genesis file is correctly formed: <code><consumer binary or gaiad> validate-genesis /path/to/genesis-without-ccv.json</code> returns without error</li> </ul> <p>See the <code>slasher</code> chain genesis for reference.</p>"},{"location":"concepts/Consumer-Launch/#consumer-addition-proposal","title":"<code>consumer-addition</code> proposal","text":"<ul> <li>[ ] Spawn time must match genesis time</li> <li>[ ] Spawn time must be later than voting period</li> <li>[ ] <code>revision_height: 1</code></li> <li>[ ] <code>revision_number: 1</code> (only if the <code>chain_id</code> ends in <code>-1</code>)</li> <li>[ ] <code>transfer_timeout_period: 1800000000000</code>. This value should be smaller than <code>blocks_per_distribution_transmission * block_time</code>.</li> <li>[ ] <code>ccv_timeout_period: 2419200000000000</code>. This value must be larger than the unbonding period, the default is 28 days.</li> <li>[ ] <code>unbonding_period: 1728000000000000</code> (given current provider params)</li> </ul> <p>See the <code>slasher</code> chain consumer-addition proposal and Interchain Security time-based parameters for reference.</p>"},{"location":"concepts/Consumer-Launch/#node-configurations","title":"Node configurations","text":"<ul> <li>[ ] <code>minimum_gas_prices</code></li> <li>[ ] Check with Hypha about any other chain-specific params</li> </ul>"},{"location":"concepts/Consumer-Launch/#on-chain-proposal-submission","title":"On-chain Proposal Submission","text":"<p>When you make your proposal, please let us know well in advance. The current voting period is five minutes, which means we\u2019ll need to vote right after you submit your proposal. We recommend submitting the proposal together with us on a call.</p> <p>The following will take place during the proposal submission phase:</p> <ul> <li>Your team will submit the <code>consumer-addition</code> proposal with a command that looks like this: <code>gaiad tx gov submit-legacy-proposal consumer-addition proposal.json --from <account name> --chain-id provider --gas auto --fees 500uatom -b block -y</code></li> <li>Testnet coordinators will vote on it shortly afterwards to make sure it passes.</li> <li>You will open a pull request to add the new consumer chain entry to this repo and update the schedule page with the launch date.</li> <li>You will announce the upcoming launch, including the spawn time, in the Interchain Security <code>announcements</code> channel of the Cosmos Network Discord Server. If you need permissions for posting, please reach out to us.</li> </ul>"},{"location":"concepts/Consumer-Launch/#chain-launch","title":"Chain Launch","text":"<p>After the spawn time is reached, the Cross-Chain Validation (CCV) state will be available on the provider chain and the new IBC client will be created. At this point, you will be able to:</p> <ul> <li>Collect the Cross-Chain Validation (CCV) state from the provider chain. <code>gaiad q provider consumer-genesis <chain-id> -o json > ccv-state.json</code></li> <li>Update the genesis file with the CCV state. <code>jq -s '.[0].app_state.ccvconsumer = .[1] | .[0]' <consumer genesis without CCV state> ccv-state.json > <consumer genesis file with CCV state></code></li> <li>Publish the genesis file with CCV state to the testnets repo.</li> <li>Post the link to the genesis file and the SHA256 hash to the Interchain Security <code>interchain-security-testnet</code> channel of the Cosmos Network Discord Server.</li> <li>Ensure the required peers are online for people to connect to.</li> </ul> <p>The consumer chain will start producing blocks as soon as 66.67% of the provider chain's voting power comes online. You will be able to start the relayer afterwards:</p> <ul> <li>Query the IBC client ID of the provider chain. <code>gaiad q provider list-consumer-chains</code></li> <li>Create the required IBC connections and channels for the CCV channel to be established. Using Hermes: <code>hermes create connection --a-chain <consumer chain ID> --a-client 07-tendermint-0 --b-client <provider chain client ID> hermes create channel --a-chain <consumer chain ID> --a-port consumer --b-port provider --order ordered --a-connection connection-0 --channel-version 1</code></li> <li>Start the relayer</li> <li>The trusting period fraction is set to <code>0.25</code> on the provider chain, so you should use a trusting period of 5 days in your relayer configuration.</li> </ul> <p>Finally, the testnet coordinators will:</p> <ul> <li>Trigger a validator set update in the provider chain to establish the CCV channel and verify the validator set has been updated in the consumer chain.</li> <li>Announce the chain is interchain secured.</li> <li>Update the testnets repo with the IBC information.</li> </ul>"},{"location":"concepts/Consumer-Launch/#talk-to-us","title":"Talk to us","text":"<p>If you're a consumer chain looking to launch, please get in touch with Hypha. You can reach Lexa Michaelides at <code>lexa@hypha.coop</code> or on Telegram.</p>"},{"location":"concepts/Self-Custody/","title":"Self Custody","text":"<p>With increasingly sensitive information being stored in centralized databases, we believe that a decentralized anonymity mechanism is the only way to protect user data. Sonr is at its core a peer-to-peer identity system, which means that users can choose to share their identity with others in a way that is private and secure.</p>"},{"location":"concepts/Self-Custody/#decentralized-identifiers","title":"Decentralized Identifiers","text":""},{"location":"concepts/Self-Custody/#cross-chain-interoperability","title":"Cross-chain Interoperability","text":""},{"location":"concepts/Self-Custody/#w3c-web-apis","title":"W3C Web APIs","text":""},{"location":"concepts/System-Architecture/","title":"System Architecture","text":"<p>Sonr is a decentralized platform that allows users to create and manage their own decentralized identity.</p>"},{"location":"concepts/System-Architecture/#blockchain-sonr","title":"Blockchain: Sonr","text":"<p>Sonr stores Decentralized Identifiers (DIDs) on its Cosmos-sdk based blockchain. The blockchain's role is to act as the persistent pointer store for locations of User owned data.</p>"},{"location":"concepts/System-Architecture/#user-key-vault-motr","title":"User Key Vault: Motr","text":"<p>The Motr node is a service-worker which functions as a personal encrypted key-enclave for users stored on IPFS. They can be allocated and persisted on the Sonr blockchain for Smart Wallet functionality.</p>"},{"location":"concepts/System-Architecture/#network-gateway-hway","title":"Network Gateway: Hway","text":"<p>The Hway protocol is a network proxy which routes network requests to the appropriate service endpoint. This is used for seamless communication between Blockchain Nodes, Decentralized Applications, and User Nodes.</p>"},{"location":"concepts/System-Architecture/#design-system-nebula","title":"Design System: Nebula","text":"<p>Built with Golang-Templ, TailwindCSS, HTMX, and Service Workers - Nebula is a component library which allows for consistent UX across the entire ecosystem.</p>"},{"location":"concepts/Token-Economy/","title":"Token Economy","text":"<p>The <code>$SNR</code> token is the native platform token of the Sonr network. It is used by services to pay for Authentication and Authorization services. The system is designed for developers to be similar to centralized authentication providers like Google, Facebook, Okta, etc.</p>"},{"location":"concepts/Token-Economy/#usage","title":"Usage","text":"<p>The Sonr blockchain is a Delegated Proof of Stake (DPoS) blockchain built with the Cosmos-sdk.</p>"},{"location":"concepts/Token-Economy/#supply","title":"Supply","text":"<p>The total supply of <code>$SNR</code> is fixed at 1 billion.</p> <p></p>"},{"location":"concepts/ibc-accounts/","title":"Interchain Accounts","text":"<p>:::note Synopsis Learn about what the Interchain Accounts module is :::</p>"},{"location":"concepts/ibc-accounts/#what-is-the-interchain-accounts-module","title":"What is the Interchain Accounts module?","text":"<p>Interchain Accounts is the Cosmos SDK implementation of the ICS-27 protocol, which enables cross-chain account management built upon IBC.</p> <ul> <li>How does an interchain account differ from a regular account?</li> </ul> <p>Regular accounts use a private key to sign transactions. Interchain Accounts are instead controlled programmatically by counterparty chains via IBC packets.</p>"},{"location":"concepts/ibc-accounts/#concepts","title":"Concepts","text":"<p><code>Host Chain</code>: The chain where the interchain account is registered. The host chain listens for IBC packets from a controller chain which should contain instructions (e.g. Cosmos SDK messages) for which the interchain account will execute.</p> <p><code>Controller Chain</code>: The chain registering and controlling an account on a host chain. The controller chain sends IBC packets to the host chain to control the account.</p> <p><code>Interchain Account</code>: An account on a host chain created using the ICS-27 protocol. An interchain account has all the capabilities of a normal account. However, rather than signing transactions with a private key, a controller chain will send IBC packets to the host chain which signals what transactions the interchain account should execute.</p> <p><code>Authentication Module</code>: A custom application module on the controller chain that uses the Interchain Accounts module to build custom logic for the creation & management of interchain accounts. It can be either an IBC application module using the legacy API, or a regular Cosmos SDK application module sending messages to the controller submodule's <code>MsgServer</code> (this is the recommended approach from ibc-go v6 if access to packet callbacks is not needed). Please note that the legacy API will eventually be removed and IBC applications will not be able to use them in later releases.</p>"},{"location":"concepts/ibc-accounts/#sdk-security-model","title":"SDK security model","text":"<p>SDK modules on a chain are assumed to be trustworthy. For example, there are no checks to prevent an untrustworthy module from accessing the bank keeper.</p> <p>The implementation of ICS-27 in ibc-go uses this assumption in its security considerations.</p> <p>The implementation assumes other IBC application modules will not bind to ports within the ICS-27 namespace.</p>"},{"location":"concepts/ibc-accounts/#channel-closure","title":"Channel Closure","text":"<p>The provided interchain account host and controller implementations do not support <code>ChanCloseInit</code>. However, they do support <code>ChanCloseConfirm</code>. This means that the host and controller modules cannot close channels, but they will confirm channel closures initiated by other implementations of ICS-27.</p> <p>In the event of a channel closing (due to a packet timeout in an ordered channel, for example), the interchain account associated with that channel can become accessible again if a new channel is created with a (JSON-formatted) version string that encodes the exact same <code>Metadata</code> information of the previous channel. The channel can be reopened using either <code>MsgRegisterInterchainAccount</code> or <code>MsgChannelOpenInit</code>. If <code>MsgRegisterInterchainAccount</code> is used, then it is possible to leave the <code>version</code> field of the message empty, since it will be filled in by the controller submodule. If <code>MsgChannelOpenInit</code> is used, then the <code>version</code> field must be provided with the correct JSON-encoded <code>Metadata</code> string. See section Understanding Active Channels for more information.</p> <p>When reopening a channel with the default controller submodule, the ordering of the channel cannot be changed. In order to change the ordering of the channel, the channel has to go through a channel upgrade handshake or reopen the channel with a custom controller implementation.</p>"},{"location":"concepts/nebula-ui/","title":"Nebula ui","text":"<p>In order to maintain a tight-knit experience, we designed Sonr to operate completely in the point-of-view of the user. This led to us building a Component Library which creates consistent UX across the entire ecosystem.</p>"},{"location":"concepts/nebula-ui/#overview","title":"Overview","text":"<p>The Sonr blockchain is a Delegated Proof of Stake (DPoS) blockchain built with the Cosmos-sdk.</p>"},{"location":"concepts/nebula-ui/#nebula-package","title":"Nebula Package","text":"<p>The total supply of <code>$SNR</code> is fixed at 1 billion.</p>"},{"location":"concepts/sdk-usage/","title":"Sdk usage","text":""},{"location":"concepts/sdk-usage/#xdid-auth-authz","title":"<code>x/did</code> - Auth & AuthZ","text":"<p>The DID module is responsible for managing the creation and management of DIDs. Controllers represent on-chain accounts backed by a MPC keypair. Controllers provide methods for Wallet Account Abstraction (WAA) and are responsible for managing the creation and management of DIDs for an individual user.</p>"},{"location":"concepts/sdk-usage/#features","title":"Features","text":"<ul> <li>DID Controllers leverage the Cosmos SDK's <code>x/accounts</code> std interface for WAA.</li> <li>DIDs are represented by a <code>x/did</code> controller and are required to state the controller's public key, and which map to the controller's capabilities.</li> <li>General Sign/Verify methods are provides from the QueryServer for HTTP requests.</li> <li>The Execute method is used to broadcast transactions across the network. (TODO)</li> <li>Biscuits are used to authenticate and authorize requests between services. (TODO)</li> </ul>"},{"location":"concepts/sdk-usage/#references","title":"References","text":"<ul> <li>State</li> <li>State Transitions</li> <li>Messages</li> <li>Queries</li> <li>Params</li> <li>Client</li> <li>Future Improvements</li> <li>Tests</li> <li>Appendix</li> </ul>"},{"location":"concepts/sdk-usage/#xmacaroon","title":"<code>x/macaroon</code>","text":"<p>The macaroon module is responsible for issuing and verifying macaroons. Macaroons are used to authenticate and authorize requests between services. Macaroons are requested by NFT Records from <code>x/service</code> and granted by controllers from <code>x/did</code></p>"},{"location":"concepts/sdk-usage/#features_1","title":"Features","text":"<ul> <li>On Controller creation, a macaroon is created with an admin scope and a default expiry of 315,569,520 blocks (or ~10 years).</li> <li>On Service registration, a macaroon is created with a service scope and a default expiry of 31,556,952 blocks (or ~1 year).</li> <li>Macaroons contain the scope of access for a service and the expiry of the permissions in <code>blockHeight</code>.</li> </ul>"},{"location":"concepts/sdk-usage/#references_1","title":"References","text":"<ul> <li>State</li> <li>State Transitions</li> <li>Messages</li> <li>Queries</li> <li>Params</li> <li>Client</li> <li>Future Improvements</li> <li>Tests</li> <li>Appendix</li> </ul>"},{"location":"concepts/sdk-usage/#xservice","title":"<code>x/service</code>","text":"<p>The service module is responsible for managing decentralized services. Services on the Sonr network are essentially on-chain MultiSig wallets that are represented by a NFT. Service admins are represented by a <code>x/did</code> controller and are required to state the service's scope of access, and which map to the services' capabilities.</p>"},{"location":"concepts/sdk-usage/#features_2","title":"Features","text":"<ul> <li>Needs a Valid Domain with .htaccess file to be whitelisted.</li> </ul>"},{"location":"concepts/sdk-usage/#references_2","title":"References","text":"<ul> <li>State</li> <li>State Transitions</li> <li>Messages</li> <li>Queries</li> <li>Params</li> <li>Client</li> <li>Future Improvements</li> <li>Tests</li> <li>Appendix</li> </ul>"},{"location":"concepts/sdk-usage/#xvault","title":"<code>x/vault</code>","text":"<p>The vault module is responsible for managing the storage and acccess-control of Decentralized Web Nodes (DWNs) from IPFS. Vaults contain user-facing keys and are represented by a <code>x/did</code> controller.</p>"},{"location":"concepts/sdk-usage/#features_3","title":"Features","text":"<ul> <li>Vaults can be created by anyone, but efforts are made to restrict 1 per user.</li> <li>Vaults are stored in IPFS and when claimed, the bech32 Sonr Address is pinned to IPFS.</li> </ul>"},{"location":"concepts/sdk-usage/#references_3","title":"References","text":"<ul> <li>State</li> <li>State Transitions</li> <li>Messages</li> <li>Queries</li> <li>Params</li> <li>Client</li> <li>Future Improvements</li> <li>Tests</li> <li>Appendix</li> </ul>"},{"location":"concepts/svc-management/","title":"Svc management","text":"<p>The <code>$SNR</code> token is the native platform token of the Sonr network. It is used by services to pay for Authentication and Authorization services. The system is designed for developers to be similar to centralized authentication providers like Google, Facebook, Okta, etc.</p>"},{"location":"concepts/svc-management/#usage","title":"Usage","text":"<p>The Sonr blockchain is a Delegated Proof of Stake (DPoS) blockchain built with the Cosmos-sdk.</p>"},{"location":"concepts/svc-management/#supply","title":"Supply","text":"<p>The total supply of <code>$SNR</code> is fixed at 1 billion.</p>"},{"location":"foundations/","title":"Sonr Blockchain","text":""},{"location":"foundations/hway/","title":"Hway","text":"# Page Not Found  The page you were looking for couldn't be found. Press [[/]] to search, or [head back to the homepage](/)."},{"location":"foundations/motr/","title":"Motr","text":"# Page Not Found  The page you were looking for couldn't be found. Press [[/]] to search, or [head back to the homepage](/)."}]} |