dreams

package module
v0.10.0 Latest Latest
Warning

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

 Go to latest Published: Jul 4, 2023 License: MIT Imports: 16 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 desktop dApps and utilities built on Dero. dReams has two facets to its use.

As a application

With a wide array of features from games to blockchain services, dReams is a 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.

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.

  • 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
  • DerBnb
    • Property rental management app
    • Mint property tokens
    • Manage rentals and bookings with Dero private messaging
    • DerBnb profit share
    • TRVL tokens
  • 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)
}
menu

The menu 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. 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 starts Gnomon with NFA search filter.

package main

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

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

// dReams menu StartGnomon() example

// Name my app
const app_tag = "My_app"

func main() {
	// Initialize Gnomon fast sync
	menu.Gnomes.Fast = true

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

	rpc.Ping()
	// Check for daemon connection, if daemon is not connected we won't start Gnomon
	if rpc.Daemon.Connect {
		// Initialize NFA search filter and start Gnomon
		filter := []string{menu.NFA_SEARCH_FILTER}
		menu.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.Connect {
			contracts := menu.Gnomes.GetAllOwnersAndSCIDs()
			log.Printf("[%s] Index contains %d contracts\n", app_tag, len(contracts))
			time.Sleep(3 * time.Second)
			rpc.Ping()
		}

		// Stop Gnomon
		menu.Gnomes.Stop(app_tag)
	}

	log.Printf("[%s] Done\n", app_tag)
}
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 and 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/menu"
	"github.com/dReam-dApps/dReams/rpc"
)

// dReams dwidget NewVerticalEntries() example

// Name my app
const app_tag = "My_app"

func main() {
	// Initialize Gnomon fast sync
	menu.Gnomes.Fast = true

	// 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 menu.Gnomes.Init {
			menu.Gnomes.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 && !menu.Gnomes.IsInitialized() && !menu.Gnomes.Start {
			go menu.StartGnomon(app_tag, "boltdb", []string{menu.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"
)

// 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, widget.NewLabel("Label"), widget.NewEntry(), widget.NewButton("Button", nil)))
	cont.Add(container.NewAdaptiveGrid(3, widget.NewLabel("Label"), widget.NewCheck("Check", nil), widget.NewButton("Button", nil)))
	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 DownloadFile 

func DownloadFile(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 GetDir 

func GetDir() (dir string)

Get current working directory path for prefix

func ThemeSelect 

func ThemeSelect() fyne.Widget

dReams app theme selection object

  • If image is not present locally, it is downloaded

Types

type AssetSelect 

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

func (*AssetSelect) Add 

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

type DreamSave 

type DreamSave struct {
	Skin    color.Gray16 `json:"skin"`
	Daemon  []string     `json:"daemon"`
	Tables  []string     `json:"tables"`
	Predict []string     `json:"predict"`
	Sports  []string     `json:"sports"`
	G45s    []string     `json:"g45s"`
	NFAs    []string     `json:"nfas"`
	DBtype  string       `json:"dbType"`
	Para    int          `json:"paraBlocks"`

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

type DreamsItems 

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

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

type DreamsObject 

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

func (*DreamsObject) CloseAllDapps 

func (d *DreamsObject) CloseAllDapps()

Send close signal to all active dApp channels

func (*DreamsObject) CloseDapp 

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

Close signal for a dApp

func (*DreamsObject) Closing 

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

Close signal for dReams

func (*DreamsObject) Configure 

func (d *DreamsObject) Configure(b bool)

Set dReams configure bool

func (*DreamsObject) IsConfiguring 

func (d *DreamsObject) IsConfiguring() bool

Check if dReams is configuring

func (*DreamsObject) IsWindows 

func (d *DreamsObject) IsWindows() bool

Check if runtime os is windows

func (*DreamsObject) Notification 

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

Notification pop up for dReams app

func (*DreamsObject) OS 

func (d *DreamsObject) OS() string

Check what OS is set

func (*DreamsObject) OnSubTab 

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

Check what sub tab is being viewed

func (*DreamsObject) OnTab 

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

Check what tab main windows is on

func (*DreamsObject) Receive 

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

Receive signal for work

func (*DreamsObject) SetChannels 

func (d *DreamsObject) SetChannels(i int)

Initialize channels

func (*DreamsObject) SetOS 

func (d *DreamsObject) SetOS()

Set what OS is being used

func (*DreamsObject) SetSubTab 

func (d *DreamsObject) SetSubTab(name string)

Set what sub tab is being viewed

func (*DreamsObject) SetTab 

func (d *DreamsObject) SetTab(name string)

Set what tab main windows is on

func (*DreamsObject) SignalChannel 

func (d *DreamsObject) SignalChannel()

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

func (*DreamsObject) StopProcess 

func (d *DreamsObject) StopProcess()

Stop the main dReams process

func (*DreamsObject) WorkDone 

func (d *DreamsObject) WorkDone()

Signal back to counter when work is done

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.