dreams

package module
v0.11.1 Latest Latest
Warning

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

 Go to latest Published: Jan 20, 2024 License: MIT Imports: 18 Imported by: 11

README

dReams

Interact with a variety of different products and services on Dero's decentralized application platform.

dReamsFooter

  1. Project
  2. dApps
  3. Features
  4. Build
  5. Packages
  6. Donations
  7. Licensing
Project

dReams is a open source platform application that houses multiple dApps and utilities built on Dero. dReams has two facets to its use.

goModgoReportgoDoc

As a application

With a wide array of features from games to blockchain services, dReams app is a desktop point of entry into the privacy preserving world of Dero.

As a repository

dReams serves as a source for building Dero applications. Written in Go and using the Fyne toolkit, the dReams repository is constructed into packages with function imports for many different Dero necessities.

Download the latest release or build from source to use dReams.

windowsOSmacOSlinuxOS

dReams Template can be used to help create new Dero dApps.

dApps

All dApps are ran on chain in a decentralized manner. dReams and packages are solely interfaces to interact with these on chain services. With the main dReams application, users can access the dApps below from one place.

  • Grokked
    • Proof of attention game
    • A player is randomly chosen as the Grok
    • If they do not pass the Grok in the time frame they are removed from the game
    • The time frame gets shorter every turn, last player standing wins
    • Deployable contracts
    • Leader boards
  • Holdero
    • Multiplayer Texas Hold'em style poker
    • In game assets
    • Deployable contracts
    • Multiple tokens supported
    • dReam Tools
  • Baccarat
    • Single player table game
    • In game assets
    • Multiple tokens supported
  • dSports and dPrediction
    • P2P betting and predictions
    • Deployable contracts
    • dService
  • Iluma
    • Tarot readings
    • Custom cards and artwork by Kalina Lux
    • Querent's companion
  • Duels
    • Duel Dero assets in a over or under showdown style game
    • Three game modes, regular, death match and hardcore
    • Asset graveyard and leader board
  • NFA Marketplace
    • View and manage owned assets
    • View and manage listings
    • Search NFAs
    • Mint NFAs
  • More dApps to come...
Features
  • Gnomon with UI controls
  • Create customs Gnomon indexes
  • Gnomon header controls
  • Send Dero messages
  • Send Dero assets
  • Deployable contract rating system
  • Dynamic app updates from on chain data
  • Import only the dApps and collections you want to use
  • Shared config files for platform wide use
Build
  • Install latest Go version
  • Install Fyne dependencies.
  • Clone repo and build with:
git clone https://github.com/dReam-dApps/dReams.git
cd dReams
cd cmd/dReams
go build .
./dReams

Packages

dReams repo is built as packages. With imports from the Dero code base, dReams variable structures are complete with the basics needs for building Dero applications that can run alone, or ones that could be integrated into dReams.

dReams Template can be used as a UI starting point and you can view our Examples repo for further references.

rpc

The rpc package contains all of the basic functionality needed to set up clients, check connectivity and read blockchain and wallet information. There are arbitrary rpc calls which any dApp can make use of such as the NFA calls, SendMessage() or SendAsset() with optional payload. This example checks for daemon and wallet rpc connectivity.

package main

import (
	"log"
	"os"
	"os/signal"
	"syscall"
	"time"

	"github.com/dReam-dApps/dReams/rpc"
)

// dReams rpc connection example

// Name my app
const app_tag = "My_app"

func main() {
	// Initialize rpc addresses to rpc.Daemon and rpc.Wallet vars
	rpc.Daemon.Rpc = "127.0.0.1:10102"
	rpc.Wallet.Rpc = "127.0.0.1:10103"
	// Initialize rpc.Wallet.UserPass for rpc user:pass

	// Check for daemon connection
	rpc.Ping()

	// Check for wallet connection and get address
	rpc.GetAddress(app_tag)

	// Exit with ctrl-C
	var exit bool
	c := make(chan os.Signal, 1)
	signal.Notify(c, os.Interrupt, syscall.SIGTERM)
	go func() {
		<-c
		log.Printf("[%s] Closing\n", app_tag)
		exit = true
	}()

	// Loop will check for daemon and wallet connection and
	// print wallet height and balance. It will keep
	// running while daemon and wallet are connected or until exit
	for !exit && rpc.IsReady() {
		rpc.Wallet.GetBalance()
		rpc.GetWalletHeight(app_tag)
		log.Printf("[%s] Height: %d   Dero Balance: %s\n", app_tag, rpc.Wallet.Height, rpc.FromAtomic(rpc.Wallet.Balance, 5))
		time.Sleep(3 * time.Second)
		rpc.Ping()
		rpc.EchoWallet(app_tag)
	}

	log.Printf("[%s] Not connected\n", app_tag)
}
gnomes

The gnomes package contains the base components used for Gnomon indexing. StartGnomon() allows apps to run a instance of Gnomon with search filter and pass optional func for any custom index requirements.

package main

import (
	"os"
	"os/signal"
	"syscall"
	"time"

	"github.com/civilware/Gnomon/structures"
	"github.com/dReam-dApps/dReams/gnomes"
	"github.com/dReam-dApps/dReams/rpc"
	"github.com/sirupsen/logrus"
)

// dReams gnomes StartGnomon() example

// Name my app
const app_tag = "My_app"

// Log output
var logger = structures.Logger.WithFields(logrus.Fields{})

// Gnomon instance from gnomes package
var gnomon = gnomes.NewGnomes()

func main() {
	// Initialize Gnomon fast sync true to sync db immediately
	gnomon.SetFastsync(true, false, 100)

	// Initialize rpc address to rpc.Daemon var
	rpc.Daemon.Rpc = "127.0.0.1:10102"

	// Initialize logger to Stdout
	gnomes.InitLogrusLog(logrus.InfoLevel)

	rpc.Ping()
	// Check for daemon connection, if daemon is not connected we won't start Gnomon
	if rpc.Daemon.IsConnected() {
		// Initialize NFA search filter and start Gnomon
		filter := []string{gnomes.NFA_SEARCH_FILTER}
		gnomes.StartGnomon(app_tag, "boltdb", filter, 0, 0, nil)

		// Exit with ctrl-C
		var exit bool
		c := make(chan os.Signal, 1)
		signal.Notify(c, os.Interrupt, syscall.SIGTERM)
		go func() {
			<-c
			exit = true
		}()

		// Gnomon will continue to run if daemon is connected
		for !exit && rpc.Daemon.IsConnected() {
			contracts := gnomon.GetAllOwnersAndSCIDs()
			logger.Printf("[%s] Index contains %d contracts\n", app_tag, len(contracts))
			time.Sleep(3 * time.Second)
			rpc.Ping()
		}

		// Stop Gnomon
		gnomon.Stop(app_tag)
	}

	logger.Printf("[%s] Done\n", app_tag)
}
menu

NFA related items such as the dReams NFA marketplace and asset controls can be independently imported for use in other dApps, it can be used with or without dReams filters. There are menu panels and custom Dero indicators that can be imported. This example shows how to import asset controls and market as app tabs.

package main

import (
	"fyne.io/fyne/v2"
	"fyne.io/fyne/v2/app"
	"fyne.io/fyne/v2/canvas"
	"fyne.io/fyne/v2/container"
	"fyne.io/fyne/v2/layout"
	"fyne.io/fyne/v2/widget"
	dreams "github.com/dReam-dApps/dReams"
	"github.com/dReam-dApps/dReams/bundle"
	"github.com/dReam-dApps/dReams/menu"
)

// dReams menu PlaceMarket and PlaceAsset example

// Name my app
const app_tag = "My_app"

func main() {
	// Intialize Fyne window app and window into dReams app object
	a := app.New()
	w := a.NewWindow(app_tag)
	w.Resize(fyne.NewSize(900, 700))
	d := dreams.AppObject{
		App:    a,
		Window: w,
	}

	// Simple asset profile with wallet name entry and theme select
	line := canvas.NewLine(bundle.TextColor)
	profile := []*widget.FormItem{}
	profile = append(profile, widget.NewFormItem("Name", menu.NameEntry()))
	profile = append(profile, widget.NewFormItem("", layout.NewSpacer()))
	profile = append(profile, widget.NewFormItem("", container.NewVBox(line)))
	profile = append(profile, widget.NewFormItem("Theme", menu.ThemeSelect(&d)))
	profile = append(profile, widget.NewFormItem("", container.NewVBox(line)))

	// Rescan button function in asset tab
	rescan := func() {
		// What you want to scan wallet for
	}

	// Place asset and market layouts into tabs
	tabs := container.NewAppTabs(
		container.NewTabItem("Assets", menu.PlaceAssets(app_tag, widget.NewForm(profile...), rescan, bundle.ResourceDReamsIconAltPng, &d)),
		container.NewTabItem("Market", menu.PlaceMarket(&d)))

	// Place tabs as window content and run app
	d.Window.SetContent(tabs)
	d.Window.ShowAndRun()
}
dwidget

The dwidget package is a extension to fyne widgets that intends to make creating dApps simpler and quicker with widgets specified for use with Dero. Numerical entries have prefix, increment and decimal control. Pre-configured connection boxes can be used that are tied into dReams rpc vars and have default Dero connection addresses populated. There is objects for shutdown control as well as a spot for the dReams indicators, or new ones. This example starts a Fyne gui app using VerticalEntries() to start Gnomon when connected.

package main

import (
	"fyne.io/fyne/v2"
	"fyne.io/fyne/v2/app"

	"github.com/dReam-dApps/dReams/dwidget"
	"github.com/dReam-dApps/dReams/gnomes"
	"github.com/dReam-dApps/dReams/rpc"
	"github.com/sirupsen/logrus"
)

// dReams dwidget NewVerticalEntries() example

// Name my app
const app_tag = "My_app"

// Gnomon instance from gnomes package
var gnomon = gnomes.NewGnomes()

func main() {
	// Initialize Gnomon fast sync true to sync db immediately
	gnomon.SetFastsync(true, false, 100)

	// Initialize logger to Stdout
	gnomes.InitLogrusLog(logrus.InfoLevel)

	// Initialize fyne app
	a := app.New()

	// Initialize fyne window with size
	w := a.NewWindow(app_tag)
	w.Resize(fyne.NewSize(300, 100))
	w.SetMaster()

	// When window closes, stop Gnomon if running
	w.SetCloseIntercept(func() {
		if gnomon.IsInitialized() {
			gnomon.Stop(app_tag)
		}
		w.Close()
	})

	// Initialize dwidget connection box
	connect_box := dwidget.NewVerticalEntries(app_tag, 1)

	// When connection button is pressed we will connect to wallet rpc,
	// and start Gnomon with NFA search filter if it is not running
	connect_box.Button.OnTapped = func() {
		rpc.GetAddress(app_tag)
		rpc.Ping()
		if rpc.Daemon.Connect && !gnomon.IsInitialized() && !gnomon.IsStarting() {
			go gnomes.StartGnomon(app_tag, "boltdb", []string{gnomes.NFA_SEARCH_FILTER}, 0, 0, nil)
		}
	}

	// Place connection box and start app
	w.SetContent(connect_box.Container)
	w.ShowAndRun()
}
bundle

The bundle package contains all dReams resources. Images, gifs and fonts can be imported as well as the two Dero styled base app themes for Fyne. This example starts a Fyne gui app with various widgets to show case both Dero themes and image imports from bundle.

package main

import (
	"image/color"

	"fyne.io/fyne/v2"
	"fyne.io/fyne/v2/app"
	"fyne.io/fyne/v2/canvas"
	"fyne.io/fyne/v2/container"
	"fyne.io/fyne/v2/widget"
	"github.com/dReam-dApps/dReams/bundle"
	"github.com/dReam-dApps/dReams/dwidget"
)

// Name my app
const app_tag = "My_app"

func main() {
	// Initialize app color to bundle var
	bundle.AppColor = color.Black

	// Initialize fyne app with Dero theme
	a := app.New()
	a.Settings().SetTheme(bundle.DeroTheme(bundle.AppColor))

	// Initialize fyne window with size and icon from bundle package
	w := a.NewWindow(app_tag)
	w.SetIcon(bundle.ResourceBlueBadge3Png)
	w.Resize(fyne.NewSize(300, 100))
	w.SetMaster()

	// Initialize fyne container and add some various widgets for viewing purposes
	cont := container.NewVBox()
	cont.Add(container.NewAdaptiveGrid(3, dwidget.NewCenterLabel("Label"), widget.NewEntry(), widget.NewButton("Button", nil)))
	cont.Add(container.NewAdaptiveGrid(3, widget.NewLabel("Label"), widget.NewCheck("Check", nil), dwidget.NewLine(30, 30, bundle.TextColor)))
	cont.Add(widget.NewPasswordEntry())
	cont.Add(widget.NewSlider(0, 100))

	// Widget to change theme
	change_theme := widget.NewRadioGroup([]string{"Dark", "Light"}, func(s string) {
		switch s {
		case "Dark":
			bundle.AppColor = color.Black
		case "Light":
			bundle.AppColor = color.White
		default:

		}

		a.Settings().SetTheme(bundle.DeroTheme(bundle.AppColor))
	})
	change_theme.Horizontal = true
	cont.Add(container.NewCenter(change_theme))

	// Add a image from bundle package
	gnomon_img := canvas.NewImageFromResource(bundle.ResourceGnomonIconPng)
	gnomon_img.SetMinSize(fyne.NewSize(45, 45))
	cont.Add(container.NewCenter(gnomon_img))

	// Adding last widget
	select_entry := widget.NewSelect([]string{"Choice 1", "Choice 2", "Choice 3"}, nil)
	cont.Add(select_entry)

	// Place widget container and start app
	w.SetContent(cont)
	w.ShowAndRun()
}

Donations

  • Dero Address: dero1qyr8yjnu6cl2c5yqkls0hmxe6rry77kn24nmc5fje6hm9jltyvdd5qq4hn5pn

DeroDonations

Licensing

dReams platform and packages are free and open source.
The source code is published under the MIT License.
Copyright © 2023 dReam dApps

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DownloadBytes added in v0.11.0 

func DownloadBytes(URL string) ([]byte, error)

Download url image file from URL and return as []byte

func DownloadCanvas added in v0.11.0 

func DownloadCanvas(URL, fileName string) (canvas.Image, error)

Download image file from URL and return as canvas.Image

func FileExists 

func FileExists(path, tag string) bool

Check if path to file exists

  • tag for log print

func FyneIcon added in v0.11.0 

func FyneIcon(name fyne.ThemeIconName) fyne.Resource

Returns Fyne theme icon for name

func GetDir 

func GetDir() (dir string)

Get current working directory path for prefix

Types

type AppObject added in v0.10.1 

type AppObject struct {
	App        fyne.App
	Window     fyne.Window
	Background *fyne.Container
	// contains filtered or unexported fields
}

AppObject holds the main app and channels

func (*AppObject) CloseAllDapps added in v0.10.1 

func (d *AppObject) CloseAllDapps()

Send close signal to all active dApp channels

func (*AppObject) CloseDapp added in v0.10.1 

func (d *AppObject) CloseDapp() <-chan struct{}

Close signal for a dApp

func (*AppObject) Closing added in v0.10.1 

func (d *AppObject) Closing() <-chan struct{}

Close signal for main app

func (*AppObject) Configure added in v0.10.1 

func (d *AppObject) Configure(b bool)

Set main configure bool

func (*AppObject) IsConfiguring added in v0.10.1 

func (d *AppObject) IsConfiguring() bool

Check if main app is configuring

func (*AppObject) IsWindows added in v0.10.1 

func (d *AppObject) IsWindows() bool

Check if runtime os is windows

func (*AppObject) Notification added in v0.10.1 

func (d *AppObject) Notification(title, content string) bool

Notification pop up for main app

func (*AppObject) OS added in v0.10.1 

func (d *AppObject) OS() string

Check what OS is set

func (*AppObject) OnSubTab added in v0.10.1 

func (d *AppObject) OnSubTab(name string) bool

Check what sub tab is being viewed

func (*AppObject) OnTab added in v0.10.1 

func (d *AppObject) OnTab(name string) bool

Check what tab main windows is on

func (*AppObject) Receive added in v0.10.1 

func (d *AppObject) Receive() <-chan struct{}

Receive signal for work

func (*AppObject) SetChannels added in v0.10.1 

func (d *AppObject) SetChannels(i int)

Initialize channels

func (*AppObject) SetOS added in v0.10.1 

func (d *AppObject) SetOS()

Set what OS is being used

func (*AppObject) SetSubTab added in v0.10.1 

func (d *AppObject) SetSubTab(name string)

Set what sub tab is being viewed

func (*AppObject) SetTab added in v0.10.1 

func (d *AppObject) SetTab(name string)

Set what tab main windows is on

func (*AppObject) SignalChannel added in v0.10.1 

func (d *AppObject) SignalChannel()

Signal all available channels when we are ready for them to work

func (*AppObject) StopProcess added in v0.10.1 

func (d *AppObject) StopProcess()

Stop the main apps process

func (*AppObject) WorkDone added in v0.10.1 

func (d *AppObject) WorkDone()

Signal back to counter when work is done

type AssetSelect 

type AssetSelect struct {
	Name   string
	URL    string
	Img    canvas.Image
	Select *widget.Select
}

Select widget items for Dero assets

func (*AssetSelect) Add 

func (a *AssetSelect) Add(add, check string)

Add a asset option to a AssetSelect

func (*AssetSelect) ClearAll added in v0.10.1 

func (a *AssetSelect) ClearAll()

Clears all assets from select options

func (*AssetSelect) RemoveAsset added in v0.10.1 

func (a *AssetSelect) RemoveAsset(rm string)

Remove a asset from Select by name

func (*AssetSelect) Sort added in v0.10.1 

func (a *AssetSelect) Sort()

Sort the select widgets options

type ContainerStack added in v0.10.1 

type ContainerStack struct {
	LeftLabel  *widget.Label
	RightLabel *widget.Label
	TopLabel   *canvas.Text

	Back    fyne.Container
	Front   fyne.Container
	Actions fyne.Container
	DApp    *fyne.Container
}

ContainerStack used for building various container/label layouts to be placed in main app

type SaveData added in v0.10.1 

type SaveData struct {
	Skin    color.Gray16 `json:"skin"`
	Daemon  []string     `json:"daemon"`
	Tables  []string     `json:"tables"`
	Predict []string     `json:"predict"`
	Sports  []string     `json:"sports"`
	Theme   string       `json:"theme"`
	DBtype  string       `json:"dbType"`
	Para    int          `json:"paraBlocks"`
	FSForce bool         `json:"fastsyncForce"`
	FSDiff  int64        `json:"fastsyncDiff"`

	Assets map[string]bool `json:"assets"`
	Dapps  map[string]bool `json:"dapps"`
}

Saved data for users local config.json file

Source Files

View all Source files

Directories

Path Synopsis
cmd
NFA
dReams

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.