data-layer-sdk

README

Synternet Data Layer SDK

Welcome to the Data Layer SDK documentation. This SDK enables seamless integration with our Data Layer solution, allowing you to harness the power of real-time data streams in your Golang applications.

data-layer-sdk is a Golang library designed specifically for the Synternet Data Layer project. Powered by the NATS messaging system, data-layer-sdk abstracts away most of the intricate details of interacting with the Data Layer Broker network and the Blockchain to offer seamless integration between your Golang applications and the Synternet Data Layer platform.

Features

• Subscribe to Existing Data Streams: Easily subscribe to pre-existing data streams within the Synternet Data Layer. Receive real-time updates and harness the power of real-time data insights in your Golang applications.

• Publish New Data Streams: Create and publish your own data streams directly from your Golang applications. Share data with other participants in the Data Layer, facilitating collaboration and enabling the creation of innovative data-driven solutions.

• Support for JSON Messages: Leverage the flexibility and interoperability of JSON messages. data-layer-sdk provides support for handling JSON data, making it easy to work with complex data structures and seamlessly integrate with other systems and platforms. Even more, the SDK allows adding your own type marshallers to support any wire data format.

• Customizable Connection Options: Tailor the connection options to suit your specific needs. Configure parameters such as connection timeouts, retry mechanisms, and authentication details to ensure a secure and reliable connection to the Synternet Data Layer platform.

Installation

To install the SDK for Data Layer, you can use Go modules or include it as a dependency in your project. Here's an example of how to add it to your project:

go get github.com/synternet/data-layer-sdk

Make sure to import the package in your code:

import "github.com/synternet/data-layer-sdk"

Getting started

In order to implement a simple publisher, you may want to embed service.Service into your publisher's struct. Then in the constructor call Service.Configure that will use options to configure the publisher. After that it is as simple as running Start on your publisher.

The minimal example is as follows:

type Publisher struct {
	*service.Service
}

// Define custom payload messages
type MyMessage struct {
	RequestWas []byte `json:"request"`
}

func New(o ...options.Option) (*Publisher, error) {
	ret := &Publisher{
		Service: &service.Service{},
	}

	err := ret.Service.Configure(o...)
	if err != nil {
		return nil, fmt.Errorf("failed configuring the publisher: %w", err)
	}

	return ret, nil
}

func (p *Publisher) Start() <-chan error {
	err := p.subscribe()
	if err != nil {
		go func() {
			p.ErrCh <- err
		}()
		return p.ErrCh
	}

	return p.Service.Start()
}

func (p *Publisher) subscribe() error {
  // Do any necessary subscriptions
	return nil
}

Tools

User credentials generator

CLI tool to generate user credentials (JWT, NKEY) from account credentials (NKEY) issued in Portal. To learn more about Synternet used NATS auth model click here

go run github.com/synternet/data-layer-sdk/cmd/gen-user@latest

Contributing

We welcome contributions from the community! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository. We appreciate your feedback and collaboration in making this SDK even better.

Contribution Guidelines

To contribute to this project, please follow the guidelines outlined in the Contribute.md file. It covers important information about how to submit bug reports, suggest new features, and submit pull requests.

Code of Conduct

This project adheres to a Code of Conduct to ensure a welcoming and inclusive environment for all contributors. Please review the guidelines and make sure to follow them in all interactions within the project.

Commit Message Format

When making changes to the codebase, it's important to follow a consistent commit message format. Please refer to the Commit Message Format for details on how to structure your commit messages.

Pull Request Template

To streamline the pull request process, we have provided a Pull Request Template that includes the necessary sections for describing your changes, related issues, proposed changes, and any additional information. Make sure to fill out the template when submitting a pull request.

We appreciate your contributions and thank you for your support in making this project better!

Support

If you encounter any difficulties or have questions regarding the Data Layer SDK, please reach out to our support team at Discord #developer-discussion. We are here to assist you and ensure a smooth experience with our SDK.

We hope this documentation provides you with a comprehensive understanding of the Golang SDK for the Data Layer. Happy coding with real-time data streams and enjoy the power of the Data Layer in your Golang applications!