feat: add apply_message_failures post condition (#138)

This PR adds the `apply_message_failures` post condition to the schema. There's currently only 1 test that uses this `no-exit-code` but it currently does not error. If you want to see the new field in JSON output then you'll need to checkout the branch from filecoin-project/lotus#3697 and add a replace to go.mod `replace github.com/filecoin-project/lotus => ../lotus`. This also updates to lotus 0.7 and specs-actors 0.9.8. resolves #134
filecoin-project · Sep 11, 2020 · 326cab3 · 326cab3
1 parent 1da16f6
commit 326cab3
Show file tree

Hide file tree

Showing 11 changed files with 66 additions and 164 deletions.
diff --git a/gen/builders/builder_message.go b/gen/builders/builder_message.go
@@ -101,7 +101,7 @@ func (b *MessageVectorBuilder) CommitApplies() {
 		panic("called CommitApplies at the wrong time")
 	}
 
-	for _, am := range b.Messages.All() {
+	for i, am := range b.Messages.All() {
 		// apply all messages that are pending application.
 		if !am.Applied {
 			b.StateTracker.ApplyMessage(am)
@@ -113,16 +113,19 @@ func (b *MessageVectorBuilder) CommitApplies() {
 			Epoch: &epoch,
 		})
 
-		// am.Result may still be nil if the message failed to be applied
-		if am.Result != nil {
-			b.vector.Post.Receipts = append(b.vector.Post.Receipts, &schema.Receipt{
+		if am.Failed {
+			b.vector.Post.ApplyMessageFailures = append(b.vector.Post.ApplyMessageFailures, i)
+		}
+
+		var receipt *schema.Receipt
+		if !am.Failed {
+			receipt = &schema.Receipt{
 				ExitCode:    int64(am.Result.ExitCode),
 				ReturnValue: am.Result.Return,
 				GasUsed:     am.Result.GasUsed,
-			})
-		} else {
-			b.vector.Post.Receipts = append(b.vector.Post.Receipts, nil)
+			}
 		}
+		b.vector.Post.Receipts = append(b.vector.Post.Receipts, receipt)
 	}
 
 	// update the internal state.
@@ -152,7 +155,7 @@ func (b *MessageVectorBuilder) Finish(w io.Writer) {
 	msgs := b.Messages.All()
 	traces := make([]types.ExecutionTrace, 0, len(msgs))
 	for _, msg := range msgs {
-		if msg.Result != nil {
+		if !msg.Failed {
 			traces = append(traces, msg.Result.ExecutionTrace)
 		}
 	}

diff --git a/gen/builders/messages.go b/gen/builders/messages.go
@@ -42,6 +42,9 @@ type ApplicableMessage struct {
 	// not safe to rely on non-nil Result as indication of application
 	// since applied messages may fail without a result.
 	Applied bool
+	// Failed is true if this message was attempted to be applied and failed.
+	// In this case ApplicableMessage.Result will be nil.
+	Failed bool
 }
 
 func (m *Messages) Sugar() *sugarMsg {

diff --git a/gen/builders/messages_typed.go b/gen/builders/messages_typed.go
@@ -16,7 +16,6 @@ import (
 	"github.com/filecoin-project/specs-actors/actors/builtin/power"
 	"github.com/filecoin-project/specs-actors/actors/builtin/reward"
 	"github.com/filecoin-project/specs-actors/actors/runtime/proof"
-	"github.com/filecoin-project/specs-actors/actors/util/adt"
 
 	"github.com/filecoin-project/go-address"
 )
@@ -37,7 +36,7 @@ func AccountConstructor(params *address.Address) TypedCall {
 	}
 }
 
-func AccountPubkeyAddress(params *adt.EmptyValue) TypedCall {
+func AccountPubkeyAddress(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsAccount.PubkeyAddress, MustSerialize(params)
 	}
@@ -47,7 +46,7 @@ func AccountPubkeyAddress(params *adt.EmptyValue) TypedCall {
 // | MARKET
 // ----------------------------------------------------------------------------
 
-func MarketConstructor(params *adt.EmptyValue) TypedCall {
+func MarketConstructor(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsMarket.Constructor, MustSerialize(params)
 	}
@@ -88,7 +87,7 @@ func MarketComputeDataCommitment(params *market.ComputeDataCommitmentParams) Typ
 		return builtin.MethodsMarket.ComputeDataCommitment, MustSerialize(params)
 	}
 }
-func MarketCronTick(params *adt.EmptyValue) TypedCall {
+func MarketCronTick(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsMarket.CronTick, MustSerialize(params)
 	}
@@ -103,7 +102,7 @@ func MinerConstructor(params *power.MinerConstructorParams) TypedCall {
 		return builtin.MethodsMiner.Constructor, MustSerialize(params)
 	}
 }
-func MinerControlAddresses(params *adt.EmptyValue) TypedCall {
+func MinerControlAddresses(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsMiner.ControlAddresses, MustSerialize(params)
 	}
@@ -238,7 +237,7 @@ func MultisigChangeNumApprovalsThreshold(params *multisig.ChangeNumApprovalsThre
 // | POWER
 // ----------------------------------------------------------------------------
 
-func PowerConstructor(params *adt.EmptyValue) TypedCall {
+func PowerConstructor(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsPower.Constructor, MustSerialize(params)
 	}
@@ -258,7 +257,7 @@ func PowerEnrollCronEvent(params *power.EnrollCronEventParams) TypedCall {
 		return builtin.MethodsPower.EnrollCronEvent, MustSerialize(params)
 	}
 }
-func PowerOnEpochTickEnd(params *adt.EmptyValue) TypedCall {
+func PowerOnEpochTickEnd(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsPower.OnEpochTickEnd, MustSerialize(params)
 	}
@@ -278,7 +277,7 @@ func PowerSubmitPoRepForBulkVerify(params *proof.SealVerifyInfo) TypedCall {
 		return builtin.MethodsPower.SubmitPoRepForBulkVerify, MustSerialize(params)
 	}
 }
-func PowerCurrentTotalPower(params *adt.EmptyValue) TypedCall {
+func PowerCurrentTotalPower(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsPower.CurrentTotalPower, MustSerialize(params)
 	}
@@ -288,7 +287,7 @@ func PowerCurrentTotalPower(params *adt.EmptyValue) TypedCall {
 // | REWARD
 // ----------------------------------------------------------------------------
 
-func RewardConstructor(params *adt.EmptyValue) TypedCall {
+func RewardConstructor(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsReward.Constructor, MustSerialize(params)
 	}
@@ -298,7 +297,7 @@ func RewardAwardBlockReward(params *reward.AwardBlockRewardParams) TypedCall {
 		return builtin.MethodsReward.AwardBlockReward, MustSerialize(params)
 	}
 }
-func RewardThisEpochReward(params *adt.EmptyValue) TypedCall {
+func RewardThisEpochReward(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsReward.ThisEpochReward, MustSerialize(params)
 	}
@@ -323,12 +322,12 @@ func PaychUpdateChannelState(params *paych.UpdateChannelStateParams) TypedCall {
 		return builtin.MethodsPaych.UpdateChannelState, MustSerialize(params)
 	}
 }
-func PaychSettle(params *adt.EmptyValue) TypedCall {
+func PaychSettle(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsPaych.Settle, MustSerialize(params)
 	}
 }
-func PaychCollect(params *adt.EmptyValue) TypedCall {
+func PaychCollect(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsPaych.Collect, MustSerialize(params)
 	}
@@ -343,7 +342,7 @@ func CronConstructor(params *cron.ConstructorParams) TypedCall {
 		return builtin.MethodsCron.Constructor, MustSerialize(params)
 	}
 }
-func CronEpochTick(params *adt.EmptyValue) TypedCall {
+func CronEpochTick(params *abi.EmptyValue) TypedCall {
 	return func() (abi.MethodNum, []byte) {
 		return builtin.MethodsCron.EpochTick, MustSerialize(params)
 	}

diff --git a/gen/builders/predicates.go b/gen/builders/predicates.go
@@ -48,11 +48,12 @@ func MessageReturns(expect cbg.CBORMarshaler) ApplyRetPredicate {
 	}
 }
 
-// Nil returns an ApplyRetPredicate that passes if the message receipt is nil.
-func Nil() ApplyRetPredicate {
+// Failed returns an ApplyRetPredicate that passes if the message failed to be
+// applied i.e. the receipt is nil.
+func Failed() ApplyRetPredicate {
 	return func(ret *vm.ApplyRet) error {
 		if ret != nil {
-			return fmt.Errorf("message receipt was not nil: %+v", ret)
+			return fmt.Errorf("message did not fail: %+v", ret)
 		}
 		return nil
 	}

diff --git a/gen/builders/state_tracker.go b/gen/builders/state_tracker.go
@@ -92,6 +92,7 @@ func (st *StateTracker) ApplyMessage(am *ApplicableMessage) {
 	am.Applied = true
 	am.Result, postRoot, err = st.Driver.ExecuteMessage(st.Stores.Blockstore, st.CurrRoot, am.Epoch, am.Message)
 	if err != nil {
+		am.Failed = true
 		return
 	}
 

diff --git a/gen/suites/nested/nested.go b/gen/suites/nested/nested.go
@@ -13,7 +13,6 @@ import (
 	"github.com/filecoin-project/specs-actors/actors/builtin/paych"
 	"github.com/filecoin-project/specs-actors/actors/builtin/reward"
 	"github.com/filecoin-project/specs-actors/actors/runtime"
-	"github.com/filecoin-project/specs-actors/actors/util/adt"
 	typegen "github.com/whyrusleeping/cbor-gen"
 
 	"github.com/filecoin-project/lotus/conformance/chaos"
@@ -190,7 +189,7 @@ func nestedSends_FailMissingParams(v *MessageVectorBuilder) {
 	stage := prepareStage(v, acctDefaultBalance, multisigBalance)
 	balanceBefore := v.StateTracker.Balance(stage.creator)
 
-	params := adt.Empty // Missing params required by AddSigner
+	params := abi.Empty // Missing params required by AddSigner
 	amtSent := abi.NewTokenAmount(1)
 	result := stage.sendOk(stage.msAddr, amtSent, builtin.MethodsMultisig.AddSigner, params, nonce)
 

diff --git a/gen/suites/vm_violations/actor_abort.go b/gen/suites/vm_violations/actor_abort.go
@@ -20,8 +20,8 @@ func actorAbort(abortCode exitcode.ExitCode, msg string, expectedCode exitcode.E
 		v.Messages.Raw(
 			sender.ID,
 			chaos.Address,
-			chaos.MethodAbort,
-			MustSerialize(&chaos.AbortArgs{Code: abortCode, Message: msg}),
+			chaos.MethodAbortWith,
+			MustSerialize(&chaos.AbortWithArgs{Code: abortCode, Message: msg}),
 			Value(big.Zero()),
 			Nonce(0),
 		)
@@ -41,13 +41,13 @@ func actorPanic(msg string) func(*MessageVectorBuilder) {
 		v.Messages.Raw(
 			sender.ID,
 			chaos.Address,
-			chaos.MethodAbort,
-			MustSerialize(&chaos.AbortArgs{NoCode: true, Message: msg}),
+			chaos.MethodAbortWith,
+			MustSerialize(&chaos.AbortWithArgs{Uncontrolled: true, Message: msg}),
 			Value(big.Zero()),
 			Nonce(0),
 		)
 		v.CommitApplies()
 
-		v.Assert.LastMessageResultSatisfies(Nil())
+		v.Assert.LastMessageResultSatisfies(Failed())
 	}
 }
diff --git a/go.mod b/go.mod
@@ -7,9 +7,9 @@ require (
 	github.com/filecoin-project/go-address v0.0.3
 	github.com/filecoin-project/go-bitfield v0.2.0
 	github.com/filecoin-project/go-crypto v0.0.0-20191218222705-effae4ea9f03
-	github.com/filecoin-project/go-state-types v0.0.0-20200905071437-95828685f9df
-	github.com/filecoin-project/lotus v0.6.2-0.20200909104030-159be5b543fd
-	github.com/filecoin-project/specs-actors v0.9.7
+	github.com/filecoin-project/go-state-types v0.0.0-20200911004822-964d6c679cfc
+	github.com/filecoin-project/lotus v0.7.0
+	github.com/filecoin-project/specs-actors v0.9.8
 	github.com/filecoin-project/test-vectors/schema v0.0.1
 	github.com/ipfs/go-block-format v0.0.2
 	github.com/ipfs/go-blockservice v0.1.4-0.20200624145336-a978cec6e834