complete basic keeper tests

internal/x/paychan/keeper.go

@@ -57,7 +57,7 @@ func (k Keeper) setPaychan(ctx sdk.Context, pych Paychan) {
 	// marshal
 	bz := k.cdc.MustMarshalBinary(pych) // panics if something goes wrong
 	// write to db
-	pychKey := paychanKey(pych.sender, pych.receiver, pych.id)
+	pychKey := paychanKey(pych.Sender, pych.Receiver, pych.Id)
 	store.Set(pychKey, bz) // panics if something goes wrong
 }
 
@@ -92,8 +92,8 @@ func (k Keeper) CreatePaychan(ctx sdk.Context, sender sdk.Address, receiver sdk.
 	// sender has enough coins - done in Subtract method
 	// TODO check if sender and receiver different?
 
-	// Calculate next id (num existing paychans plus 1)
+	// Calculate next id (just num of existing paychans - zero indexed)
-	id := int64(len(k.GetPaychans(sender, receiver)) + 1) // TODO check for overflow?
+	id := int64(len(k.GetPaychans(sender, receiver)))
 	// subtract coins from sender
 	_, tags, err := k.coinKeeper.SubtractCoins(ctx, sender, amount)
 	if err != nil {
@@ -101,10 +101,10 @@ func (k Keeper) CreatePaychan(ctx sdk.Context, sender sdk.Address, receiver sdk.
 	}
 	// create new Paychan struct
 	pych := Paychan{
-		sender:   sender,
+		Sender:   sender,
-		receiver: receiver,
+		Receiver: receiver,
-		id:       id,
+		Id:       id,
-		balance:  amount,
+		Balance:  amount,
 	}
 	// save to db
 	k.setPaychan(ctx, pych)
@@ -145,10 +145,10 @@ func (k Keeper) ClosePaychan(ctx sdk.Context, sender sdk.Address, receiver sdk.A
 		return nil, sdk.ErrUnknownAddress("paychan not found") // TODO implement custom errors
 	}
 	// compute coin distribution
-	senderAmount := pych.balance.Minus(receiverAmount) // Minus sdk.Coins method
+	senderAmount := pych.Balance.Minus(receiverAmount) // Minus sdk.Coins method
 	// check that receiverAmt not greater than paychan balance
 	if !senderAmount.IsNotNegative() {
-		return nil, sdk.ErrInsufficientFunds(pych.balance.String())
+		return nil, sdk.ErrInsufficientFunds(pych.Balance.String())
 	}
 	// add coins to sender
 	// creating account if it doesn't exist
@@ -157,7 +157,7 @@ func (k Keeper) ClosePaychan(ctx sdk.Context, sender sdk.Address, receiver sdk.A
 	k.coinKeeper.AddCoins(ctx, receiver, receiverAmount)
 
 	// delete paychan from db
-	pychKey := paychanKey(pych.sender, pych.receiver, pych.id)
+	pychKey := paychanKey(pych.Sender, pych.Receiver, pych.Id)
 	store.Delete(pychKey)
 
 	// TODO create tags

internal/x/paychan/keeper_test.go

@@ -51,6 +51,7 @@ func setupCodec() *wire.Codec {
 
 func TestKeeper(t *testing.T) {
 	// Setup
+
 	// create multistore and key
 	ms, authKey, paychanKey := setupMultiStore()
 
@@ -77,14 +78,14 @@ func TestKeeper(t *testing.T) {
 
 	// Test paychan can be set and get
 	p := Paychan{
-		sender:   sdk.Address([]byte("senderAddress")),
+		Sender:   sdk.Address([]byte("senderAddress")),
-		receiver: sdk.Address([]byte("receiverAddress")),
+		Receiver: sdk.Address([]byte("receiverAddress")),
-		id:       0,
+		Id:       0,
-		balance:  sdk.Coins{{"KVA", 100}},
+		Balance:  sdk.Coins{{"KVA", 100}},
 	}
 	paychanKeeper.setPaychan(ctx, p)
 
-	_, exists = paychanKeeper.GetPaychan(ctx, p.sender, p.receiver, p.id)
+	_, exists = paychanKeeper.GetPaychan(ctx, p.Sender, p.Receiver, p.Id)
 	if !exists {
 		t.Error("payment channel not found")
 	}
@@ -102,100 +103,39 @@ func TestKeeper(t *testing.T) {
 		t.Error("unexpected error created payment channel", err)
 	}
 
-	p, _ = paychanKeeper.GetPaychan(ctx, senderAddress, receiverAddress, 0)
+	p, exists = paychanKeeper.GetPaychan(ctx, senderAddress, receiverAddress, 0)
-	if !p.balance.IsEqual(balance) {
+	if !exists {
-		t.Error("payment channel balance incorrect", p.balance, balance)
+		t.Error("payment channel missing")
+	}
+	if !p.Balance.IsEqual(balance) {
+		t.Error("payment channel balance incorrect", p.Balance, balance)
 	}
 	expectedNewSenderFunds := senderFunds.Minus(balance)
 	if !coinKeeper.GetCoins(ctx, senderAddress).IsEqual(expectedNewSenderFunds) {
 		t.Error("sender has incorrect balance after paychan creation")
 	}
 
+	// Test close paychan under normal conditions
+	senderFunds = coinKeeper.GetCoins(ctx, senderAddress)
+	receiverAmount := sdk.Coins{{"KVA", 9}}
+	_, err = paychanKeeper.ClosePaychan(ctx, senderAddress, receiverAddress, 0, receiverAmount)
+	if err != nil {
+		t.Error("unexpected error closing payment channel", err)
+	}
+	// paychan shouldn't exist
+	_, exists = paychanKeeper.GetPaychan(ctx, senderAddress, receiverAddress, 0)
+	if exists {
+		t.Error("payment channel should not exist")
+	}
+	// sender's funds should have increased
+	expectedNewSenderFunds = senderFunds.Plus(balance.Minus(receiverAmount))
+	if !coinKeeper.GetCoins(ctx, senderAddress).IsEqual(expectedNewSenderFunds) {
+		t.Error("sender has incorrect balance after paychan creation", expectedNewSenderFunds)
+	}
+	// receiver's funds should have increased
+	expectedNewReceiverFunds := receiverAmount // started at zero
+	if !coinKeeper.GetCoins(ctx, receiverAddress).IsEqual(expectedNewReceiverFunds) {
+		t.Error("receiver has incorrect balance after paychan creation")
 	}
 
-// example from x/bank
+}
-
-//func TestKeeper(t *testing.T) {
-// ms, authKey := setupMultiStore()
-
-// cdc := wire.NewCodec()
-// auth.RegisterBaseAccount(cdc)
-
-// ctx := sdk.NewContext(ms, abci.Header{}, false, nil, log.NewNopLogger())
-// accountMapper := auth.NewAccountMapper(cdc, authKey, &auth.BaseAccount{})
-// coinKeeper := NewKeeper(accountMapper)
-
-// addr := sdk.Address([]byte("addr1"))
-// addr2 := sdk.Address([]byte("addr2"))
-// addr3 := sdk.Address([]byte("addr3"))
-// acc := accountMapper.NewAccountWithAddress(ctx, addr)
-
-// // Test GetCoins/SetCoins
-// accountMapper.SetAccount(ctx, acc)
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{}))
-
-// coinKeeper.SetCoins(ctx, addr, sdk.Coins{{"foocoin", 10}})
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{{"foocoin", 10}}))
-
-// // Test HasCoins
-// assert.True(t, coinKeeper.HasCoins(ctx, addr, sdk.Coins{{"foocoin", 10}}))
-// assert.True(t, coinKeeper.HasCoins(ctx, addr, sdk.Coins{{"foocoin", 5}}))
-// assert.False(t, coinKeeper.HasCoins(ctx, addr, sdk.Coins{{"foocoin", 15}}))
-// assert.False(t, coinKeeper.HasCoins(ctx, addr, sdk.Coins{{"barcoin", 5}}))
-
-// // Test AddCoins
-// coinKeeper.AddCoins(ctx, addr, sdk.Coins{{"foocoin", 15}})
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{{"foocoin", 25}}))
-
-// coinKeeper.AddCoins(ctx, addr, sdk.Coins{{"barcoin", 15}})
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{{"barcoin", 15}, {"foocoin", 25}}))
-
-// // Test SubtractCoins
-// coinKeeper.SubtractCoins(ctx, addr, sdk.Coins{{"foocoin", 10}})
-// coinKeeper.SubtractCoins(ctx, addr, sdk.Coins{{"barcoin", 5}})
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{{"barcoin", 10}, {"foocoin", 15}}))
-
-// coinKeeper.SubtractCoins(ctx, addr, sdk.Coins{{"barcoin", 11}})
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{{"barcoin", 10}, {"foocoin", 15}}))
-
-// coinKeeper.SubtractCoins(ctx, addr, sdk.Coins{{"barcoin", 10}})
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{{"foocoin", 15}}))
-// assert.False(t, coinKeeper.HasCoins(ctx, addr, sdk.Coins{{"barcoin", 1}}))
-
-// // Test SendCoins
-// coinKeeper.SendCoins(ctx, addr, addr2, sdk.Coins{{"foocoin", 5}})
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{{"foocoin", 10}}))
-// assert.True(t, coinKeeper.GetCoins(ctx, addr2).IsEqual(sdk.Coins{{"foocoin", 5}}))
-
-// _, err2 := coinKeeper.SendCoins(ctx, addr, addr2, sdk.Coins{{"foocoin", 50}})
-// assert.Implements(t, (*sdk.Error)(nil), err2)
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{{"foocoin", 10}}))
-// assert.True(t, coinKeeper.GetCoins(ctx, addr2).IsEqual(sdk.Coins{{"foocoin", 5}}))
-
-// coinKeeper.AddCoins(ctx, addr, sdk.Coins{{"barcoin", 30}})
-// coinKeeper.SendCoins(ctx, addr, addr2, sdk.Coins{{"barcoin", 10}, {"foocoin", 5}})
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{{"barcoin", 20}, {"foocoin", 5}}))
-// assert.True(t, coinKeeper.GetCoins(ctx, addr2).IsEqual(sdk.Coins{{"barcoin", 10}, {"foocoin", 10}}))
-
-// // Test InputOutputCoins
-// input1 := NewInput(addr2, sdk.Coins{{"foocoin", 2}})
-// output1 := NewOutput(addr, sdk.Coins{{"foocoin", 2}})
-// coinKeeper.InputOutputCoins(ctx, []Input{input1}, []Output{output1})
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{{"barcoin", 20}, {"foocoin", 7}}))
-// assert.True(t, coinKeeper.GetCoins(ctx, addr2).IsEqual(sdk.Coins{{"barcoin", 10}, {"foocoin", 8}}))
-
-// inputs := []Input{
-// 	NewInput(addr, sdk.Coins{{"foocoin", 3}}),
-// 	NewInput(addr2, sdk.Coins{{"barcoin", 3}, {"foocoin", 2}}),
-// }
-
-// outputs := []Output{
-// 	NewOutput(addr, sdk.Coins{{"barcoin", 1}}),
-// 	NewOutput(addr3, sdk.Coins{{"barcoin", 2}, {"foocoin", 5}}),
-// }
-// coinKeeper.InputOutputCoins(ctx, inputs, outputs)
-// assert.True(t, coinKeeper.GetCoins(ctx, addr).IsEqual(sdk.Coins{{"barcoin", 21}, {"foocoin", 4}}))
-// assert.True(t, coinKeeper.GetCoins(ctx, addr2).IsEqual(sdk.Coins{{"barcoin", 7}, {"foocoin", 6}}))
-// assert.True(t, coinKeeper.GetCoins(ctx, addr3).IsEqual(sdk.Coins{{"barcoin", 2}, {"foocoin", 5}}))
-
-//}

internal/x/paychan/types.go

@@ -9,10 +9,10 @@ import (
 // Used to represent paychan in keeper module and to serialize.
 // probably want to convert this to a general purpose "state"
 type Paychan struct {
-	sender   sdk.Address
+	Sender   sdk.Address
-	receiver sdk.Address
+	Receiver sdk.Address
-	id       int64
+	Id       int64
-	balance  sdk.Coins
+	Balance  sdk.Coins
 }
 
 // Message Types