wrkchains

Documentation

Index

• Variables
• func GetDefaultHashMap(wrkchainType string, hashRef string) string
• func IsSupportedHash(wrkchainType string, hashType string) (bool, error)
• func IsSupportedWrkchainType(wrkchainType string) bool
• type Geth
  • func NewGethClient() *Geth
  • func (g Geth) GetBlockAtHeight(height uint64) (WrkChainBlockHeader, error)
  • func (g Geth) GetDefaultHashMap(hashRef string) string
  • func (g Geth) IsSupportedHash(hashType string) (bool, error)
  • func (g *Geth) SetLogger(log log.Logger)
• type Tendermint
  • func NewTendermintClient() *Tendermint
  • func (t Tendermint) GetBlockAtHeight(height uint64) (WrkChainBlockHeader, error)
  • func (t Tendermint) GetDefaultHashMap(hashRef string) string
  • func (t Tendermint) IsSupportedHash(hashType string) (bool, error)
  • func (t *Tendermint) SetLogger(log log.Logger)
• type WrkChain
  • func NewWrkChain(wrkchainMeta WrkChainMeta, log log.Logger) (*WrkChain, error)
  • func (w WrkChain) GetLatestBlock() (WrkChainBlockHeader, error)
  • func (w WrkChain) GetWrkChainBlock(height uint64) (WrkChainBlockHeader, error)
• type WrkChainBlockHeader
  • func NewWrkChainBlockHeader(height uint64, blockHash string, parentHash string, hash1 string, hash2 string, ...) WrkChainBlockHeader
• type WrkChainClient
  • func WrkChainClientFactory(wrkchainType string) (WrkChainClient, error)
• type WrkChainMeta
• type WrkChainMetaQueryResponse

Variables

var (
	// SupportedWrkchainTypes is an internal reference holding the currently supported WRKChain types
	SupportedWrkchainTypes = []string{
		"geth",
		"cosmos",
		"tendermint",
	}
)

Functions

func GetDefaultHashMap

func GetDefaultHashMap(wrkchainType string, hashRef string) string

GetDefaultHashMap returns the default hash map given a WRKChain type and hash reference (i.e. hash1, hash2 and hash3) It is called during the workoracle init command

func IsSupportedHash

func IsSupportedHash(wrkchainType string, hashType string) (bool, error)

IsSupportedHash checks if the given hashType for the given chainType is currently supported by WRKOracle

func IsSupportedWrkchainType

func IsSupportedWrkchainType(wrkchainType string) bool

IsSupportedWrkchainType checks if the given chainType is currently supported by WRKOracle

Types

type Geth

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

Geth is a structure for holding a Geth based WRKChain client

func NewGethClient

func NewGethClient() *Geth

NewGethClient returns a new Geth struct

func (Geth) GetBlockAtHeight

func (g Geth) GetBlockAtHeight(height uint64) (WrkChainBlockHeader, error)

GetBlockAtHeight is used to get the block headers for a given height from a geth based WRKChain

func (Geth) GetDefaultHashMap

func (g Geth) GetDefaultHashMap(hashRef string) string

GetDefaultHashMap returns the default has mapping for a given reference

func (Geth) IsSupportedHash

func (g Geth) IsSupportedHash(hashType string) (bool, error)

IsSupportedHash checks if the given hashType for the given chainType is currently supported by WRKOracle

func (*Geth) SetLogger

func (g *Geth) SetLogger(log log.Logger)

SetLogger sets the logger

type Tendermint

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

Tendermint is a structure for holding a Tendermint based WRKChain client

func NewTendermintClient

func NewTendermintClient() *Tendermint

NewTendermintClient returns a new Tendermint struct

func (Tendermint) GetBlockAtHeight

func (t Tendermint) GetBlockAtHeight(height uint64) (WrkChainBlockHeader, error)

GetBlockAtHeight is used to get the block headers for a given height from a tendermint based WRKChain

func (Tendermint) GetDefaultHashMap

func (t Tendermint) GetDefaultHashMap(hashRef string) string

GetDefaultHashMap returns the default has mapping for a given reference

func (Tendermint) IsSupportedHash

func (t Tendermint) IsSupportedHash(hashType string) (bool, error)

IsSupportedHash checks if the given hashType for the given chainType is currently supported by WRKOracle

func (*Tendermint) SetLogger

func (t *Tendermint) SetLogger(log log.Logger)

SetLogger sets the logger

type WrkChain

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

WrkChain is a top level struct to hold WRKChain data

func NewWrkChain

func NewWrkChain(wrkchainMeta WrkChainMeta, log log.Logger) (*WrkChain, error)

NewWrkChain returns a new initialised WrkChain

func (WrkChain) GetLatestBlock

func (w WrkChain) GetLatestBlock() (WrkChainBlockHeader, error)

GetLatestBlock is a top level function to query any WRKChain type for the latest block header

func (WrkChain) GetWrkChainBlock

func (w WrkChain) GetWrkChainBlock(height uint64) (WrkChainBlockHeader, error)

GetWrkChainBlock is a top level function to query any WRKChain type for the block header at a given height

type WrkChainBlockHeader

type WrkChainBlockHeader struct {
	Height     uint64 `json:"height"`
	BlockHash  string `json:"blockhash"`
	ParentHash string `json:"parenthash"`
	Hash1      string `json:"hash1"`
	Hash2      string `json:"hash2"`
	Hash3      string `json:"hash3"`
}

WrkChainBlockHeader is the standard header object that should be returned by any WRKChain type client

func NewWrkChainBlockHeader

func NewWrkChainBlockHeader(
	height uint64,
	blockHash string,
	parentHash string,
	hash1 string,
	hash2 string,
	hash3 string,
) WrkChainBlockHeader

NewWrkChainBlockHeader returns a new initialised WrkChainBlockHeader

type WrkChainClient

type WrkChainClient interface {
	GetBlockAtHeight(height uint64) (WrkChainBlockHeader, error)
	IsSupportedHash(hashType string) (bool, error)
	GetDefaultHashMap(hashRef string) string
	SetLogger(log log.Logger)
}

WrkChainClient is a generic interface for all WRKChain clients. New WRKChain client modules should implement this interface

func WrkChainClientFactory

func WrkChainClientFactory(wrkchainType string) (WrkChainClient, error)

WrkChainClientFactory returns a basic initialised WrkChainClient client based on the given WRKChain type

type WrkChainMeta

type WrkChainMeta struct {
	WRKChainId string `json:"wrkchain_id"`
	Moniker    string `json:"moniker"`
	Name       string `json:"name"`
	Type       string `json:"type"`
}

WrkChainMeta is an object to hold WRKChain metadata when queried from Mainchain

type WrkChainMetaQueryResponse

type WrkChainMetaQueryResponse struct {
	Height string       `json:"height"`
	Result WrkChainMeta `json:"result"`
}

WrkChainMetaQueryResponse is a structure which holds Mainchain query data specifically for WRKChain metadata