Sonr
easy-to-use framework for building immersive decentralized applications.
Table of Contents
About
Sonr is building the most immersive DWeb experience for both Users and Developers alike. We believe the best way to onboard the next billion users is to create a cohesive end-to-end platform that’s composable and interoperable with all existing protocols.
For this we built our Networking layer in Libp2p and our Layer 1 Blockchain with Starport. Our network comprises of two separate nodes: Highway and Motor, which each have a specific use case on the network. In order to maximize the onboarding experience, we developed our own Wallet which has value out of the gate!
Getting Started
IPFS has established a critical piece of infrastructure that is used by the majority of DWeb protocols to different degrees. Libp2p is part of the IPFS stack and is used for the underlying peer-to-peer network for discovery, routing and data exchange.
Peers in the network can dial other peers in the network to exchange messages using various transports, like QUIC, TCP, WebSocket, and Bluetooth. Modular design of the libp2p framework enables it to build drivers for other transports. Peers can run on any device, as a cloud service, mobile application or in the browser and talk to each other as long as they are connected through the same libp2p network.
Dependencies
Configuration
This project is a pseudo-monorepo, meaning it has a single root directory and all of its packages are in subdirectories. The structure is as follows:
/app -> Exported Starport app
/cmd -> Packaged libraries
└─ cli -> + CLI Interface for Developers
└─ highway -> + Highway Node Binary
└─ motor -> + Motor Node Framework
└─ sonrd -> + Blockchain Binary
/docs -> Documentation.
/pkg -> Developed package interfaces for Sonr.
└─ crypto -> + Cryptographic utilities
└─ io -> + Device and File System utilities
└─ p2p -> + Libp2p implementation
/proto -> Cosmos SDK Protocol Definitions
/testutil -> Blockchain test utilities.
/vue -> Vue.js frontend for Cosmos SDK
/x -> Implementation of Cosmos-Sonr Schemas
Installation
CLI
To install the latest version of the Sonr blockchain node's binary, execute the following command on your machine:
curl https://sonr.ws/sonr@latest! | sudo bash
Release
To install the latest version of the Sonr blockchain node's binary, execute the following command on your machine:
curl https://sonr.ws/sonr@latest! | sudo bash
Usage
To launch the Sonr Blockchain live on multiple nodes, use starport network commands. Learn more about Starport Network.
Start the Blockchain
starport chain serve
serve command installs dependencies, builds, initializes, and starts your blockchain in development.
Run the Flutter Frontend
Starport has scaffolded a Flutter-based mobile app in the flutter directory. Run the following commands to install dependencies and start the app:
cd flutter
flutter pub get
flutter run
Run the Vue.js Frontend
Starport has scaffolded a Vue.js-based web app in the vue directory. Run the following commands to install dependencies and start the app:
cd vue
npm install
npm run serve
The frontend app is built using the @starport/vue and @starport/vuex packages. For details, see the monorepo for Starport front-end development.
Version History
v0.0.1
- Implement Sonr Blockchain client into Motor and Highway nodes
- Add Highway Service and Swagger generated clients and documentation
- Create
Registryfor storingDIDDocumentin the Blockchain
Contributors
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated!
Authors
Submitting a PR
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Acknowledgments
Tools, libraries, and frameworks that make the Sonr project possible:
License
This project facilitated under Sonr Inc. is distributed under the GPLv3 License. See LICENSE.md for more information.
Mention [stepsize] in a comment if you'd like to report some technical debt. See examples 
4 May 3, 2022
14 Jan 3, 2023
20 Nov 12, 2022
11 Nov 29, 2022
15 Jan 1, 2023
167 Dec 9, 2022
163 Nov 11, 2022
1.6k Dec 8, 2022
6 Oct 11, 2022
54 Sep 21, 2022
5 Dec 23, 2022
9 Dec 2, 2022
2 Jan 18, 2022
16 Aug 29, 2022
7 May 17, 2022
30 Nov 21, 2022
7 Apr 14, 2022
9 Dec 15, 2022
12 Dec 29, 2022