R4R: Colin/store

CHANGELOG.md

@@ -20,6 +20,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Plasma configuration file
 - Added IncludeDepositMsg with handling to allow explicit deposit inclusion into sidechain
 ### Changed
+- [\#153](https://github.com/FourthState/plasma-mvp-sidechain/pull/153) Major refactor of store/, can query with position, transaction hash, or address. REST Supported.
 - [\#141](https://github.com/FourthState/plasma-mvp-sidechain/pull/141) Dependency management is now handled by go modules instead of Dep
 - [\#129](https://github.com/FourthState/plasma-mvp-sidechain/pull/129) Updated sign command to iterate over an account to finalize transactions
 - [\#129](https://github.com/FourthState/plasma-mvp-sidechain/pull/129) Updated spend to auto generate transaction for users based on the utxos they own
@@ -36,7 +37,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - [\#147](https://github.com/FourthState/plasma-mvp-sidechain/pull/147) Fix Syncing bug where syncing nodes would panic after processing exitted inputs/deposits. Bug is explained in detail here: [\#143](https://github.com/FourthState/plasma-mvp-sidechain/issues/143)
 - [\#154](https://github.com/FourthState/plasma-mvp-sidechain/pull/154) Fixes issue where include-Deposit msg.Owner == deposit.Owner not enforced. This is necessary to prevent malicious users from rewriting an already included UTXO in store.
 ### Deprecated 
-- Dep is no longer be supported
+- Dep is no longer supported
 
 ## PreHistory
 

app/app.go

@@ -37,8 +37,8 @@ type PlasmaMVPChain struct {
 	feeAmount *big.Int
 
 	// persistent stores
-	utxoStore   store.UTXOStore
-	plasmaStore store.PlasmaStore
+	outputStore store.OutputStore
+	blockStore  store.BlockStore
 
 	// smart contract connection
 	ethConnection *eth.Plasma
@@ -58,18 +58,19 @@ func NewPlasmaMVPChain(logger log.Logger, db dbm.DB, traceStore io.Writer, optio
 	cdc := MakeCodec()
 	baseApp.SetCommitMultiStoreTracer(traceStore)
 
-	utxoStoreKey := sdk.NewKVStoreKey("utxo")
-	utxoStore := store.NewUTXOStore(utxoStoreKey)
-	plasmaStoreKey := sdk.NewKVStoreKey("plasma")
-	plasmaStore := store.NewPlasmaStore(plasmaStoreKey)
+	outputStoreKey := sdk.NewKVStoreKey("outputs")
+	outputStore := store.NewOutputStore(outputStoreKey)
+	blockStoreKey := sdk.NewKVStoreKey("block")
+	blockStore := store.NewBlockStore(blockStoreKey)
+
 	app := &PlasmaMVPChain{
 		BaseApp:   baseApp,
 		cdc:       cdc,
 		txIndex:   0,
 		feeAmount: big.NewInt(0), // we do not use `utils.BigZero` because the feeAmount is going to be updated
 
-		utxoStore:   utxoStore,
-		plasmaStore: plasmaStore,
+		blockStore:  blockStore,
+		outputStore: outputStore,
 	}
 
 	// set configs
@@ -116,25 +117,25 @@ func NewPlasmaMVPChain(logger log.Logger, db dbm.DB, traceStore io.Writer, optio
 		app.feeAmount = app.feeAmount.Add(app.feeAmount, amt)
 		return nil
 	}
-	app.Router().AddRoute(msgs.SpendMsgRoute, handlers.NewSpendHandler(app.utxoStore, app.plasmaStore, nextTxIndex, feeUpdater))
-	app.Router().AddRoute(msgs.IncludeDepositMsgRoute, handlers.NewDepositHandler(app.utxoStore, app.plasmaStore, nextTxIndex, plasmaClient))
+	app.Router().AddRoute(msgs.SpendMsgRoute, handlers.NewSpendHandler(app.outputStore, app.blockStore, nextTxIndex, feeUpdater))
+	app.Router().AddRoute(msgs.IncludeDepositMsgRoute, handlers.NewDepositHandler(app.outputStore, app.blockStore, nextTxIndex, plasmaClient))
 
 	// custom queriers
 	app.QueryRouter().
-		AddRoute("utxo", query.NewUtxoQuerier(utxoStore)).
-		AddRoute("plasma", query.NewPlasmaQuerier(plasmaStore))
+		AddRoute(store.QueryOutputStore, query.NewOutputQuerier(outputStore)).
+		AddRoute(store.QueryBlockStore, query.NewBlockQuerier(blockStore))
 
 	// Set the AnteHandler
-	app.SetAnteHandler(handlers.NewAnteHandler(app.utxoStore, app.plasmaStore, plasmaClient))
+	app.SetAnteHandler(handlers.NewAnteHandler(app.outputStore, app.blockStore, plasmaClient))
 
 	// set the rest of the chain flow
 	app.SetEndBlocker(app.endBlocker)
 	app.SetInitChainer(app.initChainer)
 
 	// mount and load stores
 	// IAVL store used by default. `fauxMerkleMode` defaults to false
-	app.MountStores(utxoStoreKey, plasmaStoreKey)
-	if err := app.LoadLatestVersion(utxoStoreKey); err != nil {
+	app.MountStores(outputStoreKey, blockStoreKey)
+	if err := app.LoadLatestVersion(outputStoreKey); err != nil {
 		fmt.Println(err)
 		os.Exit(1)
 	}
@@ -163,7 +164,7 @@ func (app *PlasmaMVPChain) endBlocker(ctx sdk.Context, req abci.RequestEndBlock)
 	// skip if the block is empty
 	if app.txIndex == 0 {
 		// try to commit any headers in the store
-		app.ethConnection.CommitPlasmaHeaders(ctx, app.plasmaStore)
+		app.ethConnection.CommitPlasmaHeaders(ctx, app.blockStore)
 		return abci.ResponseEndBlock{}
 	}
 
@@ -172,20 +173,14 @@ func (app *PlasmaMVPChain) endBlocker(ctx sdk.Context, req abci.RequestEndBlock)
 	var header [32]byte
 	copy(header[:], ctx.BlockHeader().DataHash)
 	block := plasma.NewBlock(header, app.txIndex, app.feeAmount)
-	plasmaBlockNum := app.plasmaStore.StoreBlock(ctx, tmBlockHeight, block)
-	app.ethConnection.CommitPlasmaHeaders(ctx, app.plasmaStore)
-
-	if app.feeAmount.Sign() != 0 {
-		// add a utxo in the store with position 2^16-1
-		utxo := store.UTXO{
-			Position: plasma.NewPosition(plasmaBlockNum, 1<<16-1, 0, nil),
-			Output:   plasma.NewOutput(app.operatorAddress, app.feeAmount),
-			Spent:    false,
-		}
-
-		app.utxoStore.StoreUTXO(ctx, utxo)
+	app.blockStore.StoreBlock(ctx, tmBlockHeight, block)
+
+	if app.feeAmount.Sign() == 1 {
+		app.outputStore.StoreFee(ctx, app.blockStore.PlasmaBlockHeight(ctx), plasma.NewOutput(app.operatorAddress, app.feeAmount))
 	}
 
+	app.ethConnection.CommitPlasmaHeaders(ctx, app.blockStore)
+
 	app.txIndex = 0
 	app.feeAmount = big.NewInt(0)
 

cmd/plasmacli/subcmd/eth/challenge.go

@@ -5,10 +5,7 @@ import (
 	"github.com/FourthState/plasma-mvp-sidechain/cmd/plasmacli/config"
 	ks "github.com/FourthState/plasma-mvp-sidechain/cmd/plasmacli/store"
 	"github.com/FourthState/plasma-mvp-sidechain/plasma"
-	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
-	ethcmn "github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	tm "github.com/tendermint/tendermint/rpc/core/types"
@@ -19,7 +16,6 @@ import (
 func ChallengeCmd() *cobra.Command {
 	config.AddPersistentTMFlags(challengeCmd)
 	challengeCmd.Flags().StringP(gasLimitF, "g", "300000", "gas limit for ethereum transaction")
-	challengeCmd.Flags().String(ownerF, "", "owner of the challenging transaction, required if different from the specified account")
 	challengeCmd.Flags().String(proofF, "", "merkle proof of inclusion")
 	challengeCmd.Flags().String(sigsF, "", "confirmation signatures for the challenging transaction")
 	challengeCmd.Flags().Bool(useNodeF, false, "trust connected full node")
@@ -41,7 +37,6 @@ Usage:
 	Args: cobra.ExactArgs(3),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		viper.BindPFlags(cmd.Flags())
-		ctx := context.NewCLIContext()
 
 		// parse positions
 		exitingPos, err := plasma.FromPositionString(args[0])
@@ -64,13 +59,6 @@ Usage:
 			return fmt.Errorf("failed to retrieve account key: { %s }", err)
 		}
 
-		var owner ethcmn.Address
-		if viper.GetString(ownerF) != "" {
-			owner = ethcmn.HexToAddress(viper.GetString(ownerF))
-		} else {
-			owner = crypto.PubkeyToAddress(key.PublicKey)
-		}
-
 		// bind key
 		auth := bind.NewKeyedTransactor(key)
 		transactOpts := &bind.TransactOpts{
@@ -82,7 +70,7 @@ Usage:
 		var txBytes, proof, confirmSignatures []byte
 		if viper.GetBool(useNodeF) {
 			var result *tm.ResultTx
-			result, confirmSignatures, err = getProof(ctx, owner, challengingPos)
+			result, confirmSignatures, err = getProof(challengingPos)
 			if err != nil {
 				return fmt.Errorf("failed to retrieve exit information: { %s }", err)
 			}

cmd/plasmacli/subcmd/eth/exit.go

@@ -5,11 +5,9 @@ import (
 	"github.com/FourthState/plasma-mvp-sidechain/cmd/plasmacli/config"
 	ks "github.com/FourthState/plasma-mvp-sidechain/cmd/plasmacli/store"
 	"github.com/FourthState/plasma-mvp-sidechain/plasma"
-	"github.com/cosmos/cosmos-sdk/client/context"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	ethcmn "github.com/ethereum/go-ethereum/common"
 	eth "github.com/ethereum/go-ethereum/core/types"
-	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	tm "github.com/tendermint/tendermint/rpc/core/types"
@@ -46,7 +44,6 @@ Transaction Exit Usage:
 	Args: cobra.ExactArgs(2),
 	RunE: func(cmd *cobra.Command, args []string) (err error) {
 		viper.BindPFlags(cmd.Flags())
-		ctx := context.NewCLIContext()
 		var tx *eth.Transaction
 
 		// parse position
@@ -70,7 +67,6 @@ Transaction Exit Usage:
 		if err != nil {
 			return fmt.Errorf("failed to retrieve account key: { %s }", err)
 		}
-		addr := crypto.PubkeyToAddress(key.PublicKey)
 
 		// bind key, generate transact opts
 		auth := bind.NewKeyedTransactor(key)
@@ -105,7 +101,7 @@ Transaction Exit Usage:
 		var txBytes, proof, confirmSignatures []byte
 		if viper.GetBool(useNodeF) { // query full node
 			var result *tm.ResultTx
-			result, confirmSignatures, err = getProof(ctx, addr, position)
+			result, confirmSignatures, err = getProof(position)
 			if err != nil {
 				return fmt.Errorf("failed to retrieve exit information: { %s }", err)
 			}

cmd/plasmacli/subcmd/eth/prove.go

@@ -1,13 +1,12 @@
 package eth
 
 import (
+	"encoding/json"
 	"fmt"
 	"github.com/FourthState/plasma-mvp-sidechain/cmd/plasmacli/config"
-	ks "github.com/FourthState/plasma-mvp-sidechain/cmd/plasmacli/store"
 	"github.com/FourthState/plasma-mvp-sidechain/plasma"
 	"github.com/FourthState/plasma-mvp-sidechain/store"
 	"github.com/cosmos/cosmos-sdk/client/context"
-	ethcmn "github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/rlp"
 	"github.com/spf13/cobra"
 	tm "github.com/tendermint/tendermint/rpc/core/types"
@@ -19,24 +18,18 @@ func ProveCmd() *cobra.Command {
 }
 
 var proveCmd = &cobra.Command{
-	Use:   "prove <account> <position>",
+	Use:   "prove <position>",
 	Short: "Prove transaction inclusion: prove <account> <position>",
 	Args:  cobra.ExactArgs(2),
 	Long:  "Returns proof for transaction inclusion. Use to exit transactions in the smart contract",
 	RunE: func(cmd *cobra.Command, args []string) error {
-		ctx := context.NewCLIContext()
-		addr, err := ks.GetAccount(args[0])
-		if err != nil {
-			return fmt.Errorf("failed to retrieve account: { %s }", err)
-		}
-
 		// parse position
 		position, err := plasma.FromPositionString(args[1])
 		if err != nil {
 			return err
 		}
 
-		result, sigs, err := getProof(ctx, addr, position)
+		result, sigs, err := getProof(position)
 		if err != nil {
 			return err
 		}
@@ -76,28 +69,51 @@ var proveCmd = &cobra.Command{
 
 // Returns transaction results for given position
 // Trusts connected full node
-func getProof(ctx context.CLIContext, addr ethcmn.Address, position plasma.Position) (*tm.ResultTx, []byte, error) {
-	// query for the output
-	key := append(addr.Bytes(), position.Bytes()...)
-	res, err := ctx.QueryStore(key, "utxo")
+func getProof(position plasma.Position) (*tm.ResultTx, []byte, error) {
+	ctx := context.NewCLIContext().WithTrustNode(true)
+
+	key := store.GetOutputKey(position)
+	hash, err := ctx.QueryStore(key, "outputs")
 	if err != nil {
 		return &tm.ResultTx{}, nil, err
 	}
 
-	utxo := store.UTXO{}
-	if err := rlp.DecodeBytes(res, &utxo); err != nil {
-		return &tm.ResultTx{}, nil, err
+	txKey := store.GetTxKey(hash)
+	txBytes, err := ctx.QueryStore(txKey, "outputs")
+
+	var tx store.Transaction
+	if err := rlp.DecodeBytes(txBytes, &tx); err != nil {
+		return &tm.ResultTx{}, nil, fmt.Errorf("Transaction decoding failed: %s", err.Error())
 	}
 
 	// query tm node for information about this tx
-	result, err := ctx.Client.Tx(utxo.MerkleHash, true)
+	result, err := ctx.Client.Tx(tx.Transaction.MerkleHash(), true)
 	if err != nil {
 		return &tm.ResultTx{}, nil, err
 	}
 
 	// Look for confirmation signatures
-	key = append([]byte("confirmSignature"), utxo.Position.Bytes()...)
-	sigs, err := ctx.QueryStore(key, "plasma")
+	// Ignore error if no confirm sig currently exists in store
+	var sigs []byte
+	if len(tx.SpenderTxs[position.OutputIndex]) > 0 {
+		queryPath := fmt.Sprintf("custom/utxo/tx/%s", tx.SpenderTxs[position.OutputIndex])
+		data, err := ctx.Query(queryPath, nil)
+		if err != nil {
+			return &tm.ResultTx{}, nil, err
+		}
+
+		var spenderTx store.Transaction
+		if err := json.Unmarshal(data, &spenderTx); err != nil {
+			return &tm.ResultTx{}, nil, fmt.Errorf("unmarshaling json query response: %s", err)
+		}
+		for _, input := range spenderTx.Transaction.Inputs {
+			if input.Position.String() == position.String() {
+				for _, sig := range input.ConfirmSignatures {
+					sigs = append(sigs, sig[:]...)
+				}
+			}
+		}
+	}
 
 	return result, sigs, nil
 }

cmd/plasmacli/subcmd/eth/query/deposit.go

@@ -16,8 +16,8 @@ func DepositCmd() *cobra.Command {
 
 var depositCmd = &cobra.Command{
 	Use:   "deposit <nonce>",
-	Short: "Query for a deposit that occured on the rootchain",
-	Long: `Queries for deposits that occured on the rootchain.
+	Short: "Query for a deposit that occurred on the rootchain",
+	Long: `Queries for deposits that occurred on the rootchain.
 
 Usage:
 	plasmacli eth query deposit <nonce>

cmd/plasmacli/subcmd/eth/query/rootchain.go

@@ -13,7 +13,7 @@ var rootchainCmd = &cobra.Command{
 	Use:   "rootchain",
 	Short: "Display rootchain contract information",
 	Long: `Display last committed block, total contract balance, total withdraw balance, minimum exit bond, and operator address.
-Total contract balance does not include total withdraw balance. The total withdraw balance are exits that have been finalized, but not transfered yet.`,
+Total contract balance does not include total withdraw balance. The total withdraw balance are exits that have been finalized, but not transferred yet.`,
 	Args: cobra.ExactArgs(0),
 	RunE: func(cmd *cobra.Command, agrs []string) error {
 		lastCommittedBlock, err := plasmaContract.LastCommittedBlock(nil)

cmd/plasmacli/subcmd/eth/withdraw.go

@@ -16,8 +16,8 @@ func WithdrawCmd() *cobra.Command {
 
 var withdrawCmd = &cobra.Command{
 	Use:   "withdraw <account>",
-	Short: "Withdraw all avaliable funds from rootchain contract",
-	Long: `Withdraw all avaliable funds from the rootchain contract
+	Short: "Withdraw all available funds from rootchain contract",
+	Long: `Withdraw all available funds from the rootchain contract
 
 Usage:
 	plasmacli eth withdraw <account> --gas-limit 30000`,

cmd/plasmacli/subcmd/query/info.go

@@ -40,28 +40,23 @@ var infoCmd = &cobra.Command{
 			return err
 		}
 
-		var utxos []store.UTXO
+		var utxos []store.TxOutput
 		if err := json.Unmarshal(data, &utxos); err != nil {
 			return fmt.Errorf("unmarshaling json query response: %s", err)
 		}
 
 		for i, utxo := range utxos {
 			fmt.Printf("UTXO %d\n", i)
-			fmt.Printf("Position: %s, Amount: %s, Spent: %t\n", utxo.Position, utxo.Output.Amount.String(), utxo.Spent)
-
-			// print inputs if applicable
-			inputAddresses := utxo.InputAddresses()
-			positions := utxo.InputPositions()
-			for i, _ := range inputAddresses {
-				fmt.Printf("Input Owner %d, Position: %s\n", i, positions[i])
-			}
-
-			// print spenders if applicable
-			spenderAddresses := utxo.SpenderAddresses()
-			positions = utxo.SpenderPositions()
-			for i, _ := range spenderAddresses {
-				fmt.Printf("Spender Owner %d, Position: %s\n", i, positions[i])
-			}
+			fmt.Printf("Position: %s, Amount: %s, Spent: %t\nSpender Hash: %s\n", utxo.Position, utxo.Output.Amount.String(), utxo.Spent, utxo.SpenderTx)
+			fmt.Printf("Transaction Hash: 0x%x\nConfirmationHash: 0x%x\n", utxo.TxHash, utxo.ConfirmationHash)
+			/*
+				// TODO: Add --verbose flag that if set will query TxInput and print InputAddresses and InputPositions as well
+				// print inputs if applicable
+				positions := utxo.InputPositions
+				for i, p := range positions {
+					fmt.Printf("Input %d Position: %s\n", i, p)
+				}
+			*/
 
 			fmt.Printf("End UTXO %d info\n\n", i)
 		}