core

README

Sonr Core

Sonr Core is a module for common interfaces used by the following repositories:

• sonr-io/highway-sdk
• sonr-io/motor-go
• sonr-io/blockchain

Description

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.

Getting Started

Dependencies

• Golang
• Libp2p

Installing

To install the latest version of the Sonr blockchain node's binary, execute the following command on your machine:

go get -u https://github.com/sonr-io/core

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:

/channel         ->        Real-time Key/Value Store
/crypto          ->        Core data types and functions.
/device          ->        Node Device management
/did             ->        Documentation.
/highway         ->        Data Transfer related Models.
/host            ->        Libp2p Host Configuration
/motor           ->        Identity management models and interfaces
/proto           ->        Protobuf Definition Files.
/zk          ->        Interfaces for managing Universal Wallet

Getting Started

Creating a Highway Node

The highway node is a relayer node that helps motors interact with the sonr network. It is responsible for routing messages between motors and other relayers. The highway node also provides an interface for developers to deploy custom services on the network. To have a custom build of the highway node, execute the following command on your machine:

1. go get -u github.com/sonr-io/core/highway

2. Create a simple highway node with the following:

	// Create the node.
	n, err := highway.NewHighway(ctx, host.WithPort(8084), host.WithWebAuthn("Sonr", "localhost", "http://localhost:8080", true))
	if err != nil {
		panic(err)
	}

Buf.build Type Definition

We utilize the Buf.build service in order to have standardized protobuf types and gRPC services across our repositories. If you have permitted access to the service, you can use the following command to updated types:

1. cd proto && buf build
2. buf push

Decentralized Identifiers (DIDs) Usage:

A library to parse and generate W3C DID Documents and W3C Verifiable Credentials.

Creation of a simple DID Document which is its own controller and contains an AssertionMethod.

didID, err := did.ParseDID("did:sonr:123")

// Empty did document:
doc := &did.Document{
    Context:            []did.URI{did.DIDContextV1URI()},
    ID:                 *didID,
}

// Add an assertionMethod
keyID, _ =: did.ParseDIDURL("did:sonr:123#key-1")

keyPair, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
verificationMethod, err := did.NewVerificationMethod(*keyID, did.JsonWebKey2020, did.DID{}, keyPair.Public())

// This adds the method to the VerificationMethod list and stores a reference to the assertion list
doc.AddAssertionMethod(verificationMethod)

didJson, _ := json.MarshalIndent(doc, "", "  ")
fmt.Println(string(didJson))

// Unmarshalling of a json did document:
parsedDIDDoc := did.Document{}
err = json.Unmarshal(didJson, &parsedDIDDoc)

// It can return the key in the convenient lestrrat-go/jwx JWK
parsedDIDDoc.AssertionMethod[0].JWK()

// Or return a native crypto.PublicKey
parsedDIDDoc.AssertionMethod[0].PublicKey()

Outputs:

{
  "assertionMethod": ["did:sonr:123#key-1"],
  "@context": "https://www.w3.org/ns/did/v1",
  "controller": "did:sonr:123",
  "id": "did:sonr:123",
  "verificationMethod": [
    {
      "controller": "did:sonr:123",
      "id": "did:sonr:123#key-1",
      "publicKeyJwk": {
        "crv": "P-256",
        "kty": "EC",
        "x": "UANQ8pgvJT33JbrnwMiu1L1JCGQFOEm1ThaNAJcFrWA=",
        "y": "UWm6q5n1iXyeCJLMGDInN40bkkKr8KkoTWDqJBZQXRo="
      },
      "type": "JsonWebKey2020"
    }
  ]
}

State of the library

Currently, the library is under development. The api can change without notice. Checkout the issues and PRs to be informed about any development.

Contributing

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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Authors

Contributors names and contact info

• Prad Nukala

License

This project facilitated under Sonr Inc. is distributed under the GPLv3 License. See LICENSE.md for more information.

Acknowledgments

Inspiration, code snippets, etc.

• Libp2p
• Textile
• Handshake