kwil-streamr

command module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 12, 2024 License: MIT Imports: 4 Imported by: 0

README

Kwil-Streamr

Kwil-Streamr is a collection of Kwil extensions that allows databases to natively sync with Streamr streams. Using these extensions, network operators can configure a Kwil network's validators to sync Streamr data into a database, without the need for a centralized oracle.

Sponsors

A huge thank you to the PowerPod team for sponsoring this extension. PowerPod is a revolutionary DePIN network building decentralized electric vehicle charging infrastructure. They are currently shipping their first product, Pulse, which can be found here, and are also working on several non-ev devices as well. Follow their journey to monetize every electron on X.

PowerPod Logo

Getting Started

Choose one of the links below to get started:

Build

To build from source, ensure you have Go 1.22+ installed, and run:

make build

In Your Own Kwil Binary

To use the Streamr extension in a custom Kwil binary, import the extensions found in extensions/ into your own Kwil binary and call the register function. The extensions should be registered using Go's package init function.

package main

import (
	"github.com/kwilteam/kwil-streamr/extensions"
)

func init() {
	err := extensions.RegisterExtensions()
	if err != nil {
		panic(err)
	}
}

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package client provides a client for listening to a Streamr node.
Package client provides a client for listening to a Streamr node.
listener
package listener implements a Kwil event listener extension for a Streamr node.
package listener implements a Kwil event listener extension for a Streamr node.
resolution
resolution implements a resolution extension for a Kwil node to respond to Streamr events.
resolution implements a resolution extension for a Kwil node to respond to Streamr events.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL