docs: example-plugin

docs/guide/src/example-plugin/cmd.go

@@ -0,0 +1,36 @@
+package main
+
+import (
+	wire "github.com/tendermint/go-wire"
+	"github.com/urfave/cli"
+
+	"github.com/tendermint/basecoin/cmd/commands"
+	"github.com/tendermint/basecoin/types"
+)
+
+func init() {
+	commands.RegisterTxSubcommand(ExamplePluginTxCmd)
+	commands.RegisterStartPlugin("example-plugin", func() types.Plugin { return NewExamplePlugin() })
+}
+
+var (
+	ExampleFlag = cli.BoolFlag{
+		Name:  "valid",
+		Usage: "Set this to make the transaction valid",
+	}
+
+	ExamplePluginTxCmd = cli.Command{
+		Name:  "example",
+		Usage: "Create, sign, and broadcast a transaction to the example plugin",
+		Action: func(c *cli.Context) error {
+			return cmdExamplePluginTx(c)
+		},
+		Flags: append(commands.TxFlags, ExampleFlag),
+	}
+)
+
+func cmdExamplePluginTx(c *cli.Context) error {
+	exampleFlag := c.Bool("valid")
+	exampleTx := ExamplePluginTx{exampleFlag}
+	return commands.AppTx(c, "example-plugin", wire.BinaryBytes(exampleTx))
+}

docs/guide/src/example-plugin/main.go

@@ -0,0 +1,23 @@
+package main
+
+import (
+	"os"
+
+	"github.com/tendermint/basecoin/cmd/commands"
+	"github.com/urfave/cli"
+)
+
+func main() {
+	app := cli.NewApp()
+	app.Name = "example-plugin"
+	app.Usage = "example-plugin [command] [args...]"
+	app.Version = "0.1.0"
+	app.Commands = []cli.Command{
+		commands.StartCmd,
+		commands.TxCmd,
+		commands.KeyCmd,
+		commands.QueryCmd,
+		commands.AccountCmd,
+	}
+	app.Run(os.Args)
+}

docs/guide/src/example-plugin/plugin.go

@@ -0,0 +1,80 @@
+package main
+
+import (
+	abci "github.com/tendermint/abci/types"
+	"github.com/tendermint/basecoin/types"
+	"github.com/tendermint/go-wire"
+)
+
+type ExamplePluginState struct {
+	Counter int
+}
+
+type ExamplePluginTx struct {
+	Valid bool
+}
+
+type ExamplePlugin struct {
+	name string
+}
+
+func (ep *ExamplePlugin) Name() string {
+	return ep.name
+}
+
+func (ep *ExamplePlugin) StateKey() []byte {
+	return []byte("ExamplePlugin.State")
+}
+
+func NewExamplePlugin() *ExamplePlugin {
+	return &ExamplePlugin{
+		name: "example-plugin",
+	}
+}
+
+func (ep *ExamplePlugin) SetOption(store types.KVStore, key string, value string) (log string) {
+	return ""
+}
+
+func (ep *ExamplePlugin) RunTx(store types.KVStore, ctx types.CallContext, txBytes []byte) (res abci.Result) {
+
+	// Decode tx
+	var tx ExamplePluginTx
+	err := wire.ReadBinaryBytes(txBytes, &tx)
+	if err != nil {
+		return abci.ErrBaseEncodingError.AppendLog("Error decoding tx: " + err.Error())
+	}
+
+	// Validate tx
+	if !tx.Valid {
+		return abci.ErrInternalError.AppendLog("Valid must be true")
+	}
+
+	// Load PluginState
+	var pluginState ExamplePluginState
+	stateBytes := store.Get(ep.StateKey())
+	if len(stateBytes) > 0 {
+		err = wire.ReadBinaryBytes(stateBytes, &pluginState)
+		if err != nil {
+			return abci.ErrInternalError.AppendLog("Error decoding state: " + err.Error())
+		}
+	}
+
+	//App Logic
+	pluginState.Counter += 1
+
+	// Save PluginState
+	store.Set(ep.StateKey(), wire.BinaryBytes(pluginState))
+
+	return abci.OK
+}
+
+func (ep *ExamplePlugin) InitChain(store types.KVStore, vals []*abci.Validator) {
+}
+
+func (ep *ExamplePlugin) BeginBlock(store types.KVStore, height uint64) {
+}
+
+func (ep *ExamplePlugin) EndBlock(store types.KVStore, height uint64) []*abci.Validator {
+	return nil
+}