api

Documentation

Index

• Constants
• type API
• type BlockOrder
  • func (bo BlockOrder) Int64() int64
  • func (bo BlockOrder) MarshalText() ([]byte, error)
  • func (bo *BlockOrder) UnmarshalJSON(data []byte) error

Constants

const (
	SafeBlockOrder      = BlockOrder(-4)
	FinalizedBlockOrder = BlockOrder(-3)
	PendingBlockOrder   = BlockOrder(-2)
	LatestBlockOrder    = BlockOrder(-1)
	EarliestBlockOrder  = BlockOrder(0)
)

Types

type API

type API struct {
	NameSpace string      // namespace under which the rpc methods of Service are exposed
	Service   interface{} // receiver instance which holds the methods
	Public    bool        // indication if the methods must be considered safe for public use
}

API describes the set of methods offered over the RPC interface

type BlockOrder

type BlockOrder int64

func (BlockOrder) Int64

func (bo BlockOrder) Int64() int64

func (BlockOrder) MarshalText

func (bo BlockOrder) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler. It marshals: - "safe", "finalized", "latest", "earliest" or "pending" as strings - other orders as hex

func (*BlockOrder) UnmarshalJSON

func (bo *BlockOrder) UnmarshalJSON(data []byte) error

UnmarshalJSON parses the given JSON fragment into a BlockOrder. It supports: - "safe", "finalized", "latest", "earliest" or "pending" as string arguments - the block order Returned errors: - an invalid block order error when the given argument isn't a known strings - an out of range error when the given block order is either too little or too large