comm

package

v0.8.0 Latest Latest Go to latest Published: Dec 19, 2018 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Oneledger/protocol

Links

Open Source Insights

Documentation ¶

Overview ¶

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 Tx(hash []byte, prove bool) (res *ctypes.ResultTx)
type ApplyValidatorArguments
type ExSendArguments
type SendArguments
type SwapArguments

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Block ¶ added in v0.7.1

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 ¶ added in v0.6.1

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

An async Broadcast to the chain

func BroadcastSync ¶ added in v0.6.2

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 ¶ added in v0.6.2

func IsError(result interface{}) *string

func NewAppClient ¶

func NewAppClient() client.Client

Generic Client interface, allows SetOption

func NewSDKClient ¶ added in v0.7.1

func NewSDKClient() pb.SDKClient

func Query ¶

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

Send a very specific query

func Register ¶ added in v0.7.1

func Register(base []byte)

Register the request

func SDKRequest ¶ added in v0.7.1

func SDKRequest(base interface{}) interface{}

Register the request

func Search ¶ added in v0.5.3

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 Tx ¶ added in v0.7.0

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

Types ¶

type ApplyValidatorArguments ¶ added in v0.7.1

type ApplyValidatorArguments struct {
	Id     string
	Amount string
	Purge  bool
}

type ExSendArguments ¶ added in v0.8.0

type ExSendArguments struct {
	SenderId        string
	ReceiverId      string
	SenderAddress   string
	ReceiverAddress string
	Currency        string
	Amount          string
	Gas             string
	Fee             string
	Chain           string
	ExGas           string
	ExFee           string
}

type SendArguments ¶ added in v0.8.0

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

type SwapArguments ¶ added in v0.8.0

type SwapArguments struct {
	Party        string
	CounterParty string
	Amount       string
	Currency     string
	Fee          string
	Gas          string // TODO: Not sure this is necessary, unless the chain is like Ethereum
	Exchange     string
	Excurrency   string
	Nonce        int64
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL