Merge pull request #275 from filecoin-project/fix/issue-523

propagate all gas outputs in ApplyRet
filecoin-project · May 9, 2022 · 57accc2 · 57accc2
2 parents 7c27e69 + 8d70e93
commit 57accc2
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 38 deletions.
diff --git a/cgo/types.go b/cgo/types.go
@@ -93,15 +93,23 @@ type PoStProofGo struct {
 
 /// FvmMachineExecuteResponse is a go allocated version of `FvmMachineExecuteResponse`.
 type FvmMachineExecuteResponseGo struct {
-	ExitCode    uint64
-	ReturnVal   []byte
-	GasUsed     uint64
-	PenaltyHi   uint64
-	PenaltyLo   uint64
-	MinerTipHi  uint64
-	MinerTipLo  uint64
-	ExecTrace   []byte
-	FailureInfo string
+	ExitCode             uint64
+	ReturnVal            []byte
+	GasUsed              uint64
+	PenaltyHi            uint64
+	PenaltyLo            uint64
+	MinerTipHi           uint64
+	MinerTipLo           uint64
+	BaseFeeBurnHi        uint64
+	BaseFeeBurnLo        uint64
+	OverEstimationBurnHi uint64
+	OverEstimationBurnLo uint64
+	RefundHi             uint64
+	RefundLo             uint64
+	GasRefund            int64
+	GasBurned            int64
+	ExecTrace            []byte
+	FailureInfo          string
 }
 
 func (ptr SliceBoxedUint8) slice() []byte {
@@ -636,14 +644,22 @@ func (ptr *FvmMachine) Destroy() {
 
 func (r FvmMachineExecuteResponse) copy() FvmMachineExecuteResponseGo {
 	return FvmMachineExecuteResponseGo{
-		ExitCode:    uint64(r.exit_code),
-		ReturnVal:   r.return_val.copy(),
-		GasUsed:     uint64(r.gas_used),
-		PenaltyHi:   uint64(r.penalty_hi),
-		PenaltyLo:   uint64(r.penalty_lo),
-		MinerTipHi:  uint64(r.miner_tip_hi),
-		MinerTipLo:  uint64(r.miner_tip_lo),
-		ExecTrace:   r.exec_trace.copy(),
-		FailureInfo: string(r.failure_info.slice()),
+		ExitCode:             uint64(r.exit_code),
+		ReturnVal:            r.return_val.copy(),
+		GasUsed:              uint64(r.gas_used),
+		PenaltyHi:            uint64(r.penalty_hi),
+		PenaltyLo:            uint64(r.penalty_lo),
+		MinerTipHi:           uint64(r.miner_tip_hi),
+		MinerTipLo:           uint64(r.miner_tip_lo),
+		BaseFeeBurnHi:        uint64(r.base_fee_burn_hi),
+		BaseFeeBurnLo:        uint64(r.base_fee_burn_lo),
+		OverEstimationBurnHi: uint64(r.over_estimation_burn_hi),
+		OverEstimationBurnLo: uint64(r.over_estimation_burn_lo),
+		RefundHi:             uint64(r.refund_hi),
+		RefundLo:             uint64(r.refund_lo),
+		GasRefund:            int64(r.gas_refund),
+		GasBurned:            int64(r.gas_burned),
+		ExecTrace:            r.exec_trace.copy(),
+		FailureInfo:          string(r.failure_info.slice()),
 	}
 }
diff --git a/fvm.go b/fvm.go
@@ -107,13 +107,18 @@ func (f *FVM) ApplyMessage(msgBytes []byte, chainLen uint) (*ApplyRet, error) {
 	}
 
 	return &ApplyRet{
-		Return:         resp.ReturnVal,
-		ExitCode:       resp.ExitCode,
-		GasUsed:        int64(resp.GasUsed),
-		MinerPenalty:   reformBigInt(resp.PenaltyHi, resp.PenaltyLo),
-		MinerTip:       reformBigInt(resp.MinerTipHi, resp.MinerTipLo),
-		ExecTraceBytes: resp.ExecTrace,
-		FailureInfo:    resp.FailureInfo,
+		Return:             resp.ReturnVal,
+		ExitCode:           resp.ExitCode,
+		GasUsed:            int64(resp.GasUsed),
+		MinerPenalty:       reformBigInt(resp.PenaltyHi, resp.PenaltyLo),
+		MinerTip:           reformBigInt(resp.MinerTipHi, resp.MinerTipLo),
+		BaseFeeBurn:        reformBigInt(resp.BaseFeeBurnHi, resp.BaseFeeBurnLo),
+		OverEstimationBurn: reformBigInt(resp.OverEstimationBurnHi, resp.OverEstimationBurnLo),
+		Refund:             reformBigInt(resp.RefundHi, resp.RefundLo),
+		GasRefund:          int64(resp.GasRefund),
+		GasBurned:          int64(resp.GasBurned),
+		ExecTraceBytes:     resp.ExecTrace,
+		FailureInfo:        resp.FailureInfo,
 	}, nil
 }
 
@@ -130,12 +135,17 @@ func (f *FVM) ApplyImplicitMessage(msgBytes []byte) (*ApplyRet, error) {
 	}
 
 	return &ApplyRet{
-		Return:       resp.ReturnVal,
-		ExitCode:     resp.ExitCode,
-		GasUsed:      int64(resp.GasUsed),
-		MinerPenalty: reformBigInt(resp.PenaltyHi, resp.PenaltyLo),
-		MinerTip:     reformBigInt(resp.MinerTipHi, resp.MinerTipLo),
-		FailureInfo:  resp.FailureInfo,
+		Return:             resp.ReturnVal,
+		ExitCode:           resp.ExitCode,
+		GasUsed:            int64(resp.GasUsed),
+		MinerPenalty:       reformBigInt(resp.PenaltyHi, resp.PenaltyLo),
+		MinerTip:           reformBigInt(resp.MinerTipHi, resp.MinerTipLo),
+		BaseFeeBurn:        reformBigInt(resp.BaseFeeBurnHi, resp.BaseFeeBurnLo),
+		OverEstimationBurn: reformBigInt(resp.OverEstimationBurnHi, resp.OverEstimationBurnLo),
+		Refund:             reformBigInt(resp.RefundHi, resp.RefundLo),
+		GasRefund:          int64(resp.GasRefund),
+		GasBurned:          int64(resp.GasBurned),
+		FailureInfo:        resp.FailureInfo,
 	}, nil
 }
 
@@ -150,13 +160,18 @@ func (f *FVM) Flush() (cid.Cid, error) {
 }
 
 type ApplyRet struct {
-	Return         []byte
-	ExitCode       uint64
-	GasUsed        int64
-	MinerPenalty   abi.TokenAmount
-	MinerTip       abi.TokenAmount
-	ExecTraceBytes []byte
-	FailureInfo    string
+	Return             []byte
+	ExitCode           uint64
+	GasUsed            int64
+	MinerPenalty       abi.TokenAmount
+	MinerTip           abi.TokenAmount
+	BaseFeeBurn        abi.TokenAmount
+	OverEstimationBurn abi.TokenAmount
+	Refund             abi.TokenAmount
+	GasRefund          int64
+	GasBurned          int64
+	ExecTraceBytes     []byte
+	FailureInfo        string
 }
 
 // NOTE: We only support 64bit platforms

diff --git a/rust/src/fvm/machine.rs b/rust/src/fvm/machine.rs
@@ -174,6 +174,11 @@ fn fvm_machine_execute_message(
         // TODO: use the non-bigint token amount everywhere in the FVM
         let penalty: u128 = apply_ret.penalty.try_into().unwrap();
         let miner_tip: u128 = apply_ret.miner_tip.try_into().unwrap();
+        let base_fee_burn: u128 = apply_ret.base_fee_burn.try_into().unwrap();
+        let over_estimation_burn: u128 = apply_ret.over_estimation_burn.try_into().unwrap();
+        let refund: u128 = apply_ret.refund.try_into().unwrap();
+        let gas_refund = apply_ret.gas_refund;
+        let gas_burned = apply_ret.gas_burned;
 
         let Receipt {
             exit_code,
@@ -197,6 +202,14 @@ fn fvm_machine_execute_message(
             penalty_lo: penalty as u64,
             miner_tip_hi: (miner_tip >> u64::BITS) as u64,
             miner_tip_lo: miner_tip as u64,
+            base_fee_burn_hi: (base_fee_burn >> u64::BITS) as u64,
+            base_fee_burn_lo: base_fee_burn as u64,
+            over_estimation_burn_hi: (over_estimation_burn >> u64::BITS) as u64,
+            over_estimation_burn_lo: over_estimation_burn as u64,
+            refund_hi: (refund >> u64::BITS) as u64,
+            refund_lo: refund as u64,
+            gas_refund,
+            gas_burned,
             exec_trace,
             failure_info,
         })

diff --git a/rust/src/fvm/types.rs b/rust/src/fvm/types.rs
@@ -31,6 +31,14 @@ pub struct FvmMachineExecuteResponse {
     pub penalty_lo: u64,
     pub miner_tip_hi: u64,
     pub miner_tip_lo: u64,
+    pub base_fee_burn_hi: u64,
+    pub base_fee_burn_lo: u64,
+    pub over_estimation_burn_hi: u64,
+    pub over_estimation_burn_lo: u64,
+    pub refund_hi: u64,
+    pub refund_lo: u64,
+    pub gas_refund: i64,
+    pub gas_burned: i64,
     pub exec_trace: Option<c_slice::Box<u8>>,
     pub failure_info: Option<str::Box>,
 }