comm

Documentation

Overview

Copyright 2017-2018 OneLedger

Cover over the Tendermint client handling.

TODO: Make this generic to handle HTTP and local clients

Copyright 2017-2018 OneLedger

Cover over the arguments of client requests

Index

• func Block(height int64) (res *ctypes.ResultBlock)
• func Broadcast(packet []byte) *ctypes.ResultBroadcastTxCommit
• func BroadcastAsync(packet []byte) *ctypes.ResultBroadcastTx
• func BroadcastSync(packet []byte) *ctypes.ResultBroadcastTx
• func GetClient() (client rpcclient.Client)
• func IsError(result interface{}) *string
• func NewAppClient() client.Client
• func NewSDKClient() pb.SDKClient
• func Query(path string, packet []byte) interface{}
• func Register(base []byte)
• func SDKRequest(base interface{}) interface{}
• func Search(query string, prove bool, page, perPage int) (res *ctypes.ResultTxSearch)
• func SetOption(key string, value string)
• func StopClient()
• func Tx(hash []byte, prove bool) (res *ctypes.ResultTx)
• type ApplyValidatorArguments
• type ExSendArguments
• type SendArguments
• type SwapArguments

Functions

func Block

func Block(height int64) (res *ctypes.ResultBlock)

func Broadcast

func Broadcast(packet []byte) *ctypes.ResultBroadcastTxCommit

A sync'ed broadcast to the chain that waits for the commit to happen

func BroadcastAsync

func BroadcastAsync(packet []byte) *ctypes.ResultBroadcastTx

An async Broadcast to the chain

func BroadcastSync

func BroadcastSync(packet []byte) *ctypes.ResultBroadcastTx

A sync'ed broadcast to the chain that waits for the commit to happen

func GetClient

func GetClient() (client rpcclient.Client)

HTTP interface, allows Broadcast? TODO: Want to switch client type, based on config or cli args.

func IsError

func IsError(result interface{}) *string

func NewAppClient

func NewAppClient() client.Client

Generic Client interface, allows SetOption

func NewSDKClient

func NewSDKClient() pb.SDKClient

func Query

func Query(path string, packet []byte) interface{}

Send a very specific query

func Register

func Register(base []byte)

Register the request

func SDKRequest

func SDKRequest(base interface{}) interface{}

Register the request

func Search

func Search(query string, prove bool, page, perPage int) (res *ctypes.ResultTxSearch)

func SetOption

func SetOption(key string, value string)

Set an option in the ABCi app directly

func StopClient

func StopClient()

func Tx

func Tx(hash []byte, prove bool) (res *ctypes.ResultTx)

Types

type ApplyValidatorArguments

type ApplyValidatorArguments struct {
	Id     string
	Amount float64
	Purge  bool
}

type ExSendArguments

type ExSendArguments struct {
	SenderId        string
	ReceiverId      string
	SenderAddress   string
	ReceiverAddress string
	Currency        string
	Amount          float64

	Gas int64
	Fee float64

	Chain string
	ExGas string
	ExFee string
}

type SendArguments

type SendArguments struct {
	Party        string
	CounterParty string
	Currency     string
	Amount       float64
	Fee          float64
}

type SwapArguments

type SwapArguments struct {
	Party        string
	CounterParty string
	Amount       float64
	Currency     string
	Exchange     float64
	Excurrency   string
	Nonce        int64

	Fee float64
	Gas int64
}