add method GetBeneficiary

actors/builtin/methods.go

@@ -104,7 +104,8 @@ var MethodsMiner = struct {
 	ProveCommitAggregate     abi.MethodNum
 	ProveReplicaUpdates      abi.MethodNum
 	ChangeBeneficiary        abi.MethodNum
-}{MethodConstructor, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28}
+	GetBeneficiary           abi.MethodNum
+}{MethodConstructor, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29}
 
 var MethodsVerifiedRegistry = struct {
 	Constructor                 abi.MethodNum

actors/builtin/miner/miner_actor.go

@@ -4,16 +4,16 @@ import (
 	"bytes"
 	"encoding/binary"
 	"fmt"
+	"github.com/filecoin-project/go-bitfield"
+	"github.com/filecoin-project/go-state-types/exitcode"
 	"math"
 
 	addr "github.com/filecoin-project/go-address"
-	"github.com/filecoin-project/go-bitfield"
 	"github.com/filecoin-project/go-state-types/abi"
 	"github.com/filecoin-project/go-state-types/big"
 	"github.com/filecoin-project/go-state-types/cbor"
 	"github.com/filecoin-project/go-state-types/crypto"
 	"github.com/filecoin-project/go-state-types/dline"
-	"github.com/filecoin-project/go-state-types/exitcode"
 	rtt "github.com/filecoin-project/go-state-types/rt"
 	miner0 "github.com/filecoin-project/specs-actors/actors/builtin/miner"
 	miner2 "github.com/filecoin-project/specs-actors/v2/actors/builtin/miner"
@@ -79,6 +79,7 @@ func (a Actor) Exports() []interface{} {
 		26:                        a.ProveCommitAggregate,
 		27:                        a.ProveReplicaUpdates,
 		28:                        a.ChangeBeneficiary,
+		29:                        a.GetBeneficiary,
 	}
 }
 
@@ -2392,7 +2393,6 @@ type ChangeBeneficiaryParams struct {
 	NewExpiration  abi.ChainEpoch
 }
 
-
 // ChangeBeneficiary proposes/approves a beneficiary change
 func (a Actor) ChangeBeneficiary(rt Runtime, params *ChangeBeneficiaryParams) *abi.EmptyValue {
 	newBeneficiary, ok := rt.ResolveAddress(params.NewBeneficiary)
@@ -2465,6 +2465,33 @@ func (a Actor) ChangeBeneficiary(rt Runtime, params *ChangeBeneficiaryParams) *a
 	return nil
 }
 
+type ActiveBeneficiary struct {
+	Beneficiary addr.Address
+	Term        BeneficiaryTerm
+}
+
+type GetBeneficiaryReturn struct {
+	Active   ActiveBeneficiary
+	Proposed *PendingBeneficiaryChange
+}
+
+// GetBeneficiary retrieves the currently active and proposed beneficiary information.
+// This method is for use by other actors (such as those acting as beneficiaries),
+// and to abstract the state representation for clients.
+func (a Actor) GetBeneficiary(rt Runtime, _ *abi.EmptyValue) *GetBeneficiaryReturn {
+	rt.ValidateImmediateCallerAcceptAny()
+	var st State
+	rt.StateReadonly(&st)
+	info := getMinerInfo(rt, &st)
+	return &GetBeneficiaryReturn{
+		Active: ActiveBeneficiary{
+			Beneficiary: info.Beneficiary,
+			Term:        info.BeneficiaryTerm,
+		},
+		Proposed: info.PendingBeneficiaryTerm,
+	}
+}
+
 //////////
 // Cron //
 //////////
@@ -3211,4 +3238,4 @@ func checkPeerInfo(rt Runtime, peerID abi.PeerID, multiaddrs []abi.Multiaddrs) {
 
 func checkPendingBeneficiaryTerm(rt Runtime, pendingTerm *PendingBeneficiaryChange) {
 	builtin.RequirePredicate(rt, pendingTerm != nil, exitcode.ErrForbidden, "No changeBeneficiary proposal exists")
-}
+}

actors/builtin/miner/miner_test.go

@@ -377,7 +377,88 @@ func TestControlAddresses(t *testing.T) {
 		assert.Equal(t, actor.controlAddrs, control)
 		actor.checkState(rt)
 	})
+}
+
+// Tests for fetching and manipulating miner addresses.
+func TestGetBeneficiary(t *testing.T) {
+	periodOffset := abi.ChainEpoch(100)
+	firstBeneficiaryId := tutil.NewIDAddr(t, 999)
+	firstBeneficiary := tutil.NewBLSAddr(t, 100)
+	secondBeneficiaryId := tutil.NewIDAddr(t, 1999)
+	secondBeneficiary := tutil.NewBLSAddr(t, 1000)
+
+	actor := newHarness(t, periodOffset)
+	builder := builderForHarness(actor).
+		WithBalance(bigBalance, big.NewInt(10000))
+
+	t.Run("successfully change beneficiary to another address", func(t *testing.T) {
+		rt := builder.Build(t)
+		rt.AddIDAddress(firstBeneficiary, firstBeneficiaryId)
+		rt.AddIDAddress(secondBeneficiary, secondBeneficiaryId)
+		actor.constructAndVerify(rt)
+
+		//initial beneficiary
+		beneficiaryReturn := actor.getBeneficiary(rt)
+		assert.Equal(t, actor.owner, beneficiaryReturn.Active.Beneficiary)
+		assert.Equal(t, big.Zero(), beneficiaryReturn.Active.Term.Quota)
+		assert.Equal(t, abi.ChainEpoch(0), beneficiaryReturn.Active.Term.Expiration)
+		assert.Nil(t, beneficiaryReturn.Proposed)
+
+		expiration := periodOffset * 2
+		firstQuota := abi.NewTokenAmount(1000)
+		actor.proposeAndApproveInitialBeneficiary(rt, firstBeneficiaryId, miner.BeneficiaryTerm{
+			Quota:      firstQuota,
+			Expiration: expiration,
+			UsedQuota:  big.Zero(),
+		})
 
+		beneficiaryReturn = actor.getBeneficiary(rt)
+		assert.Equal(t, firstBeneficiaryId, beneficiaryReturn.Active.Beneficiary)
+		assert.Equal(t, firstQuota, beneficiaryReturn.Active.Term.Quota)
+		assert.Equal(t, expiration, beneficiaryReturn.Active.Term.Expiration)
+		assert.Nil(t, beneficiaryReturn.Proposed)
+
+		//change beneficiary from non owner address to non owner address
+		rt.SetEpoch(periodOffset + 10)
+		secondQuota := abi.NewTokenAmount(100)
+		secondExpiation := periodOffset + 20
+		actor.changeBeneficiary(rt, actor.owner, beneficiaryChange{secondBeneficiaryId, secondQuota, secondExpiation}, nil)
+		beneficiaryReturn = actor.getBeneficiary(rt)
+		assert.Equal(t, firstBeneficiaryId, beneficiaryReturn.Active.Beneficiary)
+		assert.Equal(t, firstQuota, beneficiaryReturn.Active.Term.Quota)
+		assert.Equal(t, expiration, beneficiaryReturn.Active.Term.Expiration)
+		assert.Equal(t, secondBeneficiaryId, beneficiaryReturn.Proposed.NewBeneficiary)
+		assert.Equal(t, secondExpiation, beneficiaryReturn.Proposed.NewExpiration)
+		assert.Equal(t, secondQuota, beneficiaryReturn.Proposed.NewQuota)
+		assert.Equal(t, false, beneficiaryReturn.Proposed.ApprovedByBeneficiary)
+		assert.Equal(t, false, beneficiaryReturn.Proposed.ApprovedByNominee)
+
+		//confirm by old beneficiary address
+		actor.changeBeneficiary(rt, firstBeneficiary, beneficiaryChange{secondBeneficiaryId, secondQuota, secondExpiation}, nil)
+		beneficiaryReturn = actor.getBeneficiary(rt)
+		assert.Equal(t, firstBeneficiaryId, beneficiaryReturn.Active.Beneficiary)
+		assert.Equal(t, firstQuota, beneficiaryReturn.Active.Term.Quota)
+		assert.Equal(t, expiration, beneficiaryReturn.Active.Term.Expiration)
+		assert.Equal(t, secondBeneficiaryId, beneficiaryReturn.Proposed.NewBeneficiary)
+		assert.Equal(t, secondExpiation, beneficiaryReturn.Proposed.NewExpiration)
+		assert.Equal(t, secondQuota, beneficiaryReturn.Proposed.NewQuota)
+		assert.Equal(t, true, beneficiaryReturn.Proposed.ApprovedByBeneficiary)
+		assert.Equal(t, false, beneficiaryReturn.Proposed.ApprovedByNominee)
+
+		//confirm by new beneficiary address and worked
+		actor.changeBeneficiary(rt, secondBeneficiary, beneficiaryChange{secondBeneficiaryId, secondQuota, secondExpiation}, &secondBeneficiaryId)
+		beneficiaryReturn = actor.getBeneficiary(rt)
+		assert.Equal(t, secondBeneficiaryId, beneficiaryReturn.Active.Beneficiary)
+		assert.Equal(t, secondQuota, beneficiaryReturn.Active.Term.Quota)
+		assert.Equal(t, secondExpiation, beneficiaryReturn.Active.Term.Expiration)
+		assert.Nil(t, beneficiaryReturn.Proposed)
+
+		withdrawAmount := big.NewInt(10)
+		actor.withdrawFunds(rt, withdrawAmount, withdrawAmount, big.Zero())
+		beneficiaryReturn = actor.getBeneficiary(rt)
+		assert.Equal(t, withdrawAmount, beneficiaryReturn.Active.Term.UsedQuota)
+		actor.checkState(rt)
+	})
 }
 
 func TestWindowPost(t *testing.T) {
@@ -4299,6 +4380,14 @@ func (h *actorHarness) controlAddresses(rt *mock.Runtime) (owner, worker addr.Ad
 	return ret.Owner, ret.Worker, ret.ControlAddrs
 }
 
+func (h *actorHarness) getBeneficiary(rt *mock.Runtime) *miner.GetBeneficiaryReturn {
+	rt.ExpectValidateCallerAny()
+	ret := rt.Call(h.a.GetBeneficiary, nil).(*miner.GetBeneficiaryReturn)
+	require.NotNil(h.t, ret)
+	rt.Verify()
+	return ret
+}
+
 // Options for preCommitSector behaviour.
 // Default zero values should let everything be ok.
 type preCommitConf struct {

gen/gen.go

@@ -183,6 +183,8 @@ func main() {
 		miner.WorkerKeyChange{},
 		miner.ChangeBeneficiaryParams{},
 		miner.BeneficiaryTerm{},
+		miner.GetBeneficiaryReturn{},
+		miner.ActiveBeneficiary{},
 		miner.PendingBeneficiaryChange{},
 		miner.VestingFunds{},
 		miner.VestingFund{},