wrkchains

Documentation

Index

• type Geth
  • func NewGethClient(log log.Logger) *Geth
  • func (g Geth) GetBlockAtHeight(height uint64) (types.WrkChainBlockHeader, error)
• type Tendermint
  • func NewTendermintClient(log log.Logger) *Tendermint
  • func (t Tendermint) GetBlockAtHeight(height uint64) (types.WrkChainBlockHeader, error)
• type WrkChain
  • func NewWrkChain(wrkchainMeta types.WrkChainMeta, log log.Logger) (*WrkChain, error)
  • func (w WrkChain) GetLatestBlock() (types.WrkChainBlockHeader, error)
  • func (w WrkChain) GetWrkChainBlock(height uint64) (types.WrkChainBlockHeader, error)
• type WrkChainClient

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(log log.Logger) *Geth

NewGethClient returns a new Geth struct

func (Geth) GetBlockAtHeight

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

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

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(log log.Logger) *Tendermint

NewTendermintClient returns a new Tendermint struct

func (Tendermint) GetBlockAtHeight

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

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

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 types.WrkChainMeta, log log.Logger) (*WrkChain, error)

NewWrkChain returns a new initialised WrkChain

func (WrkChain) GetLatestBlock

func (w WrkChain) GetLatestBlock() (types.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) (types.WrkChainBlockHeader, error)

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

type WrkChainClient

type WrkChainClient interface {
	GetBlockAtHeight(height uint64) (types.WrkChainBlockHeader, error)
}

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