app

Documentation

Overview

Package app contains standard implementations of a number of components.

It is a good place to get started buuilding your first app, and to see how to wire together the various components. You can then replace them with custom implementations, as your project grows.

Package app is a generated protocol buffer package.

It is generated from these files:
	app/codec.proto

It has these top-level messages:
	Tx

Index

• Variables
• func Application(name string, h weave.Handler, tx weave.TxDecoder, dbPath string, debug bool) (app.BaseApp, error)
• func Authenticator() x.Authenticator
• func CashControl() cash.Controller
• func Chain(minFee x.Coin, authFn x.Authenticator) app.Decorators
• func CommitKVStore(dbPath string) (weave.CommitKVStore, error)
• func Examples() []commands.Example
• func GenInitOptions(args []string) (json.RawMessage, error)
• func GenerateApp(home string, logger log.Logger, debug bool) (abci.Application, error)
• func GenerateCoinKey() (weave.Address, string, error)
• func QueryRouter() weave.QueryRouter
• func Router(authFn x.Authenticator) app.Router
• func Stack(minFee x.Coin) weave.Handler
• func TxDecoder(bz []byte) (weave.Tx, error)
• type Tx
  • func (*Tx) Descriptor() ([]byte, []int)
  • func (m *Tx) GetFees() *cash.FeeInfo
  • func (tx *Tx) GetMsg() (weave.Msg, error)
  • func (m *Tx) GetSendMsg() *cash.SendMsg
  • func (m *Tx) GetSetValidatorsMsg() *validators.SetValidatorsMsg
  • func (tx *Tx) GetSignBytes() ([]byte, error)
  • func (m *Tx) GetSignatures() []*sigs.StdSignature
  • func (m *Tx) GetSum() isTx_Sum
  • func (m *Tx) Marshal() (dAtA []byte, err error)
  • func (m *Tx) MarshalTo(dAtA []byte) (int, error)
  • func (*Tx) ProtoMessage()
  • func (m *Tx) Reset()
  • func (m *Tx) Size() (n int)
  • func (m *Tx) String() string
  • func (m *Tx) Unmarshal(dAtA []byte) error
  • func (*Tx) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
• type Tx_SendMsg
  • func (m *Tx_SendMsg) MarshalTo(dAtA []byte) (int, error)
  • func (m *Tx_SendMsg) Size() (n int)
• type Tx_SetValidatorsMsg
  • func (m *Tx_SetValidatorsMsg) MarshalTo(dAtA []byte) (int, error)
  • func (m *Tx_SetValidatorsMsg) Size() (n int)

Variables

var (
	ErrInvalidLengthCodec = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowCodec   = fmt.Errorf("proto: integer overflow")
)

Functions

func Application

func Application(name string, h weave.Handler,
	tx weave.TxDecoder, dbPath string, debug bool) (app.BaseApp, error)

Application constructs a basic ABCI application with the given arguments. If you are not sure what to use for the Handler, just use Stack().

func Authenticator

func Authenticator() x.Authenticator

Authenticator returns the typical authentication, just using public key signatures

func CashControl

func CashControl() cash.Controller

CashControl returns a controller for cash functions

func Chain

func Chain(minFee x.Coin, authFn x.Authenticator) app.Decorators

Chain returns a chain of decorators, to handle authentication, fees, logging, and recovery

func CommitKVStore

func CommitKVStore(dbPath string) (weave.CommitKVStore, error)

CommitKVStore returns an initialized KVStore that persists the data to the named path.

func Examples

func Examples() []commands.Example

Examples generates some example structs to dump out with testgen

func GenInitOptions

func GenInitOptions(args []string) (json.RawMessage, error)

GenInitOptions will produce some basic options for one rich account, to use for dev mode

You can set

func GenerateApp

func GenerateApp(home string, logger log.Logger, debug bool) (abci.Application, error)

GenerateApp is used to create a stub for server/start.go command

func GenerateCoinKey

func GenerateCoinKey() (weave.Address, string, error)

GenerateCoinKey returns the address of a public key, along with the secret phrase to recover the private key. You can give coins to this address and return the recovery phrase to the user to access them.

func QueryRouter

func QueryRouter() weave.QueryRouter

QueryRouter returns a default query router, allowing access to "/wallets", "/auth", and "/"

func Router

func Router(authFn x.Authenticator) app.Router

Router returns a default router, only dispatching to the cash.SendMsg

func Stack

func Stack(minFee x.Coin) weave.Handler

Stack wires up a standard router with a standard decorator chain. This can be passed into BaseApp.

func TxDecoder

func TxDecoder(bz []byte) (weave.Tx, error)

TxDecoder creates a Tx and unmarshals bytes into it

Types

type Tx

type Tx struct {
	// msg is a sum type over all allowed messages on this chain.
	//
	// Types that are valid to be assigned to Sum:
	//	*Tx_SendMsg
	//	*Tx_SetValidatorsMsg
	Sum isTx_Sum `protobuf_oneof:"sum"`
	// fee info, autogenerates GetFees()
	Fees *cash.FeeInfo `protobuf:"bytes,20,opt,name=fees" json:"fees,omitempty"`
	// signatures, autogenerates GetSignatures()
	Signatures []*sigs.StdSignature `protobuf:"bytes,21,rep,name=signatures" json:"signatures,omitempty"`
}

Tx contains the message

func (*Tx) Descriptor

func (*Tx) Descriptor() ([]byte, []int)

func (*Tx) GetFees

func (m *Tx) GetFees() *cash.FeeInfo

func (*Tx) GetMsg

func (tx *Tx) GetMsg() (weave.Msg, error)

GetMsg switches over all types defined in the protobuf file

func (*Tx) GetSendMsg

func (m *Tx) GetSendMsg() *cash.SendMsg

func (*Tx) GetSetValidatorsMsg

func (m *Tx) GetSetValidatorsMsg() *validators.SetValidatorsMsg

func (*Tx) GetSignBytes

func (tx *Tx) GetSignBytes() ([]byte, error)

GetSignBytes returns the bytes to sign...

func (*Tx) GetSignatures

func (m *Tx) GetSignatures() []*sigs.StdSignature

func (*Tx) GetSum

func (m *Tx) GetSum() isTx_Sum

func (*Tx) Marshal

func (m *Tx) Marshal() (dAtA []byte, err error)

func (*Tx) MarshalTo

func (m *Tx) MarshalTo(dAtA []byte) (int, error)

func (*Tx) ProtoMessage

func (*Tx) ProtoMessage()

func (*Tx) Reset

func (m *Tx) Reset()

func (*Tx) Size

func (m *Tx) Size() (n int)

func (*Tx) String

func (m *Tx) String() string

func (*Tx) Unmarshal

func (m *Tx) Unmarshal(dAtA []byte) error

func (*Tx) XXX_OneofFuncs

func (*Tx) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type Tx_SendMsg

type Tx_SendMsg struct {
	SendMsg *cash.SendMsg `protobuf:"bytes,1,opt,name=send_msg,json=sendMsg,oneof"`
}

func (*Tx_SendMsg) MarshalTo

func (m *Tx_SendMsg) MarshalTo(dAtA []byte) (int, error)

func (*Tx_SendMsg) Size

func (m *Tx_SendMsg) Size() (n int)

type Tx_SetValidatorsMsg

type Tx_SetValidatorsMsg struct {
	SetValidatorsMsg *validators.SetValidatorsMsg `protobuf:"bytes,2,opt,name=set_validators_msg,json=setValidatorsMsg,oneof"`
}

func (*Tx_SetValidatorsMsg) MarshalTo

func (m *Tx_SetValidatorsMsg) MarshalTo(dAtA []byte) (int, error)

func (*Tx_SetValidatorsMsg) Size

func (m *Tx_SetValidatorsMsg) Size() (n int)