data

package
v0.8.1 Latest Latest
Warning

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

 Go to latest Published: Dec 31, 2018 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Copyright 2017 - 2018 OneLedger

Define chains as they are seen in OneLedher

Keep the state of the MerkleTrees between the different stages of consensus

We need an up to date tree to check new transactions against. We then need to apply them when delivered. We also need to get to the last tree.

The difficulty comes from the underlying code not quite being thread-safe...

Copyright 2017 - 2018 OneLedger

Encapsulate the coins, allow int64 for interfacing and big.Int as base type

Copyright 2017 - 2018 OneLedger

Basic datatypes

Encapsulate the underlying storage from our app. Currently using: 

Tendermint's memdb (just an in-memory Merkle Tree)
Tendermint's persistent kvstore (with Merkle Trees & Proofs)
	- Can only be opened by one process...

Only one connection can occur to LevelDB at a time...

Index

Constants

This section is empty.

Variables

View Source 
var Currencies map[string]Currency = map[string]Currency{
	"OLT": Currency{"OLT", ONELEDGER, 0},
	"BTC": Currency{"BTC", BITCOIN, 1},
	"ETH": Currency{"ETH", ETHEREUM, 2},
	"VT":  Currency{"VT", ONELEDGER, 3},
}

TODO: These need to be driven from a domain database, also they are many-to-one with chains

View Source 
var CurrenciesExtra map[string]Extra = map[string]Extra{
	"OLT": Extra{big.NewFloat(1000000000000000000), 6, 'f'},
	"BTC": Extra{big.NewFloat(1), 0, 'f'},
	"ETH": Extra{big.NewFloat(1), 0, 'f'},
	"VT":  Extra{big.NewFloat(1), 0, 'f'},
}

TODO: Separated from Currency to avoid serializing big floats and giving out this info

Functions

func FileExists added in v0.6.2 

func FileExists(name string, dir string) bool

TODO: Should be moved to some common/shared/utils directory Test to see if this exists already

func GetBase added in v0.8.0 

func GetBase(currency string) *big.Float

Types

type Balance 

type Balance struct {
	// Address id.Address
	Amounts map[int]Coin
}

Wrap the amount with owner information

func NewBalance 

func NewBalance() *Balance

func NewBalanceFromCoin added in v0.7.1 

func NewBalanceFromCoin(coin Coin) *Balance

func NewBalanceFromInt added in v0.8.0 

func NewBalanceFromInt(amount int64, currency string) *Balance

func NewBalanceFromString added in v0.7.1 

func NewBalanceFromString(amount string, currency string) *Balance

func (*Balance) AddAmount added in v0.8.0 

func (b *Balance) AddAmount(coin Coin)

func (*Balance) AddCoin added in v0.8.0 

func (b *Balance) AddCoin(coin Coin)

Add a new or existing coin

func (*Balance) FindCoin added in v0.8.0 

func (b *Balance) FindCoin(currency Currency) *Coin

func (*Balance) GetAmountByName added in v0.7.1 

func (b *Balance) GetAmountByName(name string) Coin

TODO: GetCoinByName?

func (*Balance) GetCoin added in v0.8.0 

func (b *Balance) GetCoin(currency Currency) Coin

func (Balance) IsEnoughBalance added in v0.8.0 

func (b Balance) IsEnoughBalance(balance Balance) bool

func (*Balance) MinusAmount added in v0.8.0 

func (b *Balance) MinusAmount(coin Coin)

func (*Balance) MinusCoin added in v0.8.0 

func (b *Balance) MinusCoin(coin Coin)

func (*Balance) SetAmount added in v0.8.0 

func (b *Balance) SetAmount(coin Coin)

func (Balance) String added in v0.7.1 

func (balance Balance) String() string

String used in fmt and Dump

type Chain 

type Chain struct {
	ChainType   ChainType
	Description string
	Features    []string
}

type ChainNode 

type ChainNode struct {
	ChainType ChainType
	Location  string
}

A specific node in a chain

type ChainState 

type ChainState struct {
	Name string
	Type StorageType

	Delivered *iavl.MutableTree // Build us a new set of transactions

	Checked   *iavl.MutableTree // Temporary and can be Rolled Back
	Committed *iavl.MutableTree // Last Persistent Tree

	// Last committed values
	LastVersion int64
	Version     int64
	LastHash    []byte
	Hash        []byte
	TreeHeight  int
	// contains filtered or unexported fields
}

func NewChainState 

func NewChainState(name string, newType StorageType) *ChainState

func (*ChainState) Close added in v0.7.0 

func (c *ChainState) Close()

func (*ChainState) Commit 

func (state *ChainState) Commit() ([]byte, int64)

TODO: Not sure about this, it seems to be Cosmos-sdk's way of getting arround the immutable copy problem...

func (*ChainState) Dump 

func (state *ChainState) Dump()

func (*ChainState) Exists 

func (state *ChainState) Exists(key DatabaseKey) bool

TODO: Should be against the commit tree, not the delivered one!!!

func (*ChainState) FindAll 

func (state *ChainState) FindAll() map[string]*Balance

Expensive O(n) search through everything...

func (*ChainState) Get added in v0.6.2 

func (state *ChainState) Get(key DatabaseKey) *Balance

TODO: Should be against the commit tree, not the delivered one!!!

func (*ChainState) Set 

func (state *ChainState) Set(key DatabaseKey, balance *Balance)

Do this only for the Delivery side

func (*ChainState) Test 

func (state *ChainState) Test(key DatabaseKey, balance *Balance)

Do this only for the Check side

type ChainType 

type ChainType int
const (
	UNKNOWN ChainType = iota
	ONELEDGER
	BITCOIN
	ETHEREUM
)

TODO: These should be in a domain database

func (ChainType) String added in v0.6.2 

func (ctype ChainType) String() string

type Coin 

type Coin struct {
	Currency Currency `json:"currency"`
	Amount   *big.Int `json:"amount"`
}

Coin is the basic amount, specified in integers, at the smallest increment (i.e. a satoshi, not a bitcoin)

func NewCoinFromFloat added in v0.8.0 

func NewCoinFromFloat(amount float64, currency string) Coin

Create a coin from floating point

func NewCoinFromInt added in v0.8.0 

func NewCoinFromInt(amount int64, currency string) Coin

Create a coin from integer (not fractional)

func NewCoinFromString added in v0.8.0 

func NewCoinFromString(amount string, currency string) Coin

Create a coin from string

func NewCoinFromUnits added in v0.8.1 

func NewCoinFromUnits(amount int64, currency string) Coin

func (Coin) Divide added in v0.8.0 

func (coin Coin) Divide(value int) Coin

func (Coin) Equals 

func (coin Coin) Equals(value Coin) bool

Equals another coin

func (Coin) Float64 added in v0.8.1 

func (coin Coin) Float64() float64

func (Coin) IsCurrency 

func (coin Coin) IsCurrency(currencies ...string) bool

See if the coin is one of a list of currencies

func (Coin) IsValid 

func (coin Coin) IsValid() bool

IsValid coin or is it broken

func (Coin) LessThan 

func (coin Coin) LessThan(value float64) bool

LessThan, just for OLTs...

func (Coin) LessThanCoin added in v0.8.0 

func (coin Coin) LessThanCoin(value Coin) bool

LessThan, for coins...

func (Coin) LessThanEqual 

func (coin Coin) LessThanEqual(value float64) bool

LessThanEqual, just for OLTs...

func (Coin) LessThanEqualCoin added in v0.8.0 

func (coin Coin) LessThanEqualCoin(value Coin) bool

LessThanEqual, for coins...

func (Coin) Minus 

func (coin Coin) Minus(value Coin) Coin

Minus two coins

func (Coin) Multiply added in v0.7.0 

func (coin Coin) Multiply(value Coin) Coin

Multiply one coin by another

func (Coin) MultiplyInt added in v0.8.0 

func (coin Coin) MultiplyInt(value int) Coin

Multiply one coin by another

func (Coin) Plus 

func (coin Coin) Plus(value Coin) Coin

Plus two coins

func (Coin) Quotient added in v0.7.0 

func (coin Coin) Quotient(value Coin) Coin

Quotient of one coin by another (divide without remainder, modulus, etc)

func (Coin) String added in v0.7.1 

func (coin Coin) String() string

Turn a coin into a readable, floating point string with the currency

type Coins 

type Coins []Coin

type Currency added in v0.5.0 

type Currency struct {
	Name  string    `json:"name"`
	Chain ChainType `json:"chain"`
	Id    int       `json:"id"`
}

func NewCurrency added in v0.6.2 

func NewCurrency(currency string) Currency

Look up the currency

func (Currency) Key added in v0.8.0 

func (c Currency) Key() string

Key sets a encodable key for the currency entry, we may end up using currencyCodes instead.

type DatabaseKey 

type DatabaseKey = []byte // Database key

type Datastore 

type Datastore interface {
	// Contruction/Destruction
	//Initialize(name string)
	Close()
	Reopen()

	// Some of the databases require commits, some are persisted right way
	Begin() Session

	// Readonly, not in a session
	FindAll() []DatabaseKey
	Exists(key DatabaseKey) bool
	Get(key DatabaseKey) interface{}

	// Give out a listof errors
	Errors() string
	Dump()
}

Database is a consistent interface for all underlying persistent data stores.

func NewDatastore 

func NewDatastore(name string, stype StorageType) Datastore

type Entry added in v0.8.0 

type Entry struct {
	Value interface{}
}

type Extra added in v0.8.0 

type Extra struct {
	Units   *big.Float
	Decimal int
	Format  uint8
}

func GetExtra added in v0.8.0 

func GetExtra(currency string) Extra

type KeyValue added in v0.6.2 

type KeyValue struct {
	Type StorageType

	Name string
	File string
	// contains filtered or unexported fields
}

Wrap the underlying usage

func NewKeyValue added in v0.6.2 

func NewKeyValue(name string, newType StorageType) *KeyValue

NewKeyValue initializes a new application

func (KeyValue) Begin added in v0.6.2 

func (store KeyValue) Begin() Session

Begin a new writable session

func (KeyValue) Close added in v0.6.2 

func (store KeyValue) Close()

Close the database

func (KeyValue) Dump added in v0.6.2 

func (store KeyValue) Dump()

Dump out debugging information from the KeyValue datastore

func (KeyValue) Errors added in v0.6.2 

func (store KeyValue) Errors() string

Print out the error details

func (KeyValue) Exists added in v0.6.2 

func (store KeyValue) Exists(key DatabaseKey) bool

Test to see if a key exists

func (KeyValue) FindAll added in v0.6.2 

func (store KeyValue) FindAll() []DatabaseKey

FindAll of the keys in the database

func (KeyValue) Get added in v0.6.2 

func (store KeyValue) Get(key DatabaseKey) interface{}

Get a key from the database

func (KeyValue) Reopen added in v0.6.2 

func (store KeyValue) Reopen()

Close and reopen the datastore

type KeyValueSession added in v0.6.2 

type KeyValueSession struct {
	// contains filtered or unexported fields
}

func (KeyValueSession) Commit added in v0.6.2 

func (session KeyValueSession) Commit() bool

Commit the changes to persistence

func (KeyValueSession) Delete added in v0.6.2 

func (session KeyValueSession) Delete(key DatabaseKey) bool

Delete a key from the datastore

func (KeyValueSession) Dump added in v0.6.2 

func (session KeyValueSession) Dump()

Dump out the contents of the database

func (KeyValueSession) Errors added in v0.6.2 

func (session KeyValueSession) Errors() string

List out the errors

func (KeyValueSession) Exists added in v0.6.2 

func (session KeyValueSession) Exists(key DatabaseKey) bool

Test to see if a key exists

func (KeyValueSession) FindAll added in v0.6.2 

func (session KeyValueSession) FindAll() []DatabaseKey

Find all of the keys in the datastore

func (KeyValueSession) Get added in v0.6.2 

func (session KeyValueSession) Get(key DatabaseKey) interface{}

Load return the stored value

func (KeyValueSession) Rollback added in v0.6.2 

func (session KeyValueSession) Rollback() bool

Rollback any changes since the last commit

func (KeyValueSession) Set added in v0.6.2 

func (session KeyValueSession) Set(key DatabaseKey, value interface{}) bool

Store inserts or updates a value under a key

type Message 

type Message = []byte // TODO: Maybe replaced by something better named?

type MultiMap added in v0.8.0 

type MultiMap struct {
	Name map[string]VersionMap
}

func NewMultiMap added in v0.8.0 

func NewMultiMap() *MultiMap

func (*MultiMap) Get added in v0.8.0 

func (mmap *MultiMap) Get(name string, version version.Version) Entry

func (*MultiMap) Set added in v0.8.0 

func (mmap *MultiMap) Set(name string, version version.Version, entry interface{})

type Script added in v0.8.0 

type Script struct {
	Script []byte
}

type ScriptRecords added in v0.8.0 

type ScriptRecords struct {
	Name map[string]Versions
}

func NewScriptRecords added in v0.8.0 

func NewScriptRecords() *ScriptRecords

func (*ScriptRecords) Set added in v0.8.0 

func (scriptRecords *ScriptRecords) Set(name string, version version.Version, script Script)

type Session added in v0.6.2 

type Session interface {
	// Primary operations
	FindAll() []DatabaseKey
	Exists(key DatabaseKey) bool
	Get(key DatabaseKey) interface{}
	Set(key DatabaseKey, value interface{}) bool
	Delete(key DatabaseKey) bool

	// Finish the sessions
	Commit() bool
	Rollback() bool

	Errors() string
	Dump()
}

Open a session (transaction in the database sense, not blockchain).

func NewKeyValueSession added in v0.6.2 

func NewKeyValueSession(store *KeyValue) Session

Create a new session

type StorageType added in v0.6.2 

type StorageType int

ENUM for datastore type 

const (
	MEMORY StorageType = iota
	PERSISTENT
)

Different types

type VersionMap added in v0.8.0 

type VersionMap struct {
	Version map[string]Entry
}

TODO: serial won't let us use a Version struct as the map key

func NewVersionMap added in v0.8.0 

func NewVersionMap() *VersionMap

type Versions added in v0.8.0 

type Versions struct {
	Version map[string]Script
}

func NewVersions added in v0.8.0 

func NewVersions() *Versions

Source Files

View all Source files

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.