rewarding

package
v0.5.0-rc3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 7, 2019 License: Apache-2.0 Imports: 16 Imported by: 12

Documentation

Index

Constants

View Source 
const (
	// ProtocolID is the protocol ID
	// TODO: it works only for one instance per protocol definition now
	ProtocolID = "rewarding"
)

Variables

This section is empty.

Functions

func DepositGas added in v0.5.0 

func DepositGas(ctx context.Context, sm protocol.StateManager, amount *big.Int, registry *protocol.Registry) error

DepositGas deposits gas into the rewarding fund

Types

type Protocol 

type Protocol struct {
	// contains filtered or unexported fields
}

Protocol defines the protocol of the rewarding fund and the rewarding process. It allows the admin to config the reward amount, users to donate tokens to the fund, block producers to grant them block and epoch reward and, beneficiaries to claim the balance into their personal account.

func NewProtocol 

func NewProtocol(cm protocol.ChainManager, rp *rolldpos.Protocol) *Protocol

NewProtocol instantiates a rewarding protocol instance.

func (*Protocol) Admin 

func (p *Protocol) Admin(
	_ context.Context,
	sm protocol.StateManager,
) (address.Address, error)

Admin returns the address of current admin

func (*Protocol) AvailableBalance 

func (p *Protocol) AvailableBalance(
	ctx context.Context,
	sm protocol.StateManager,
) (*big.Int, error)

AvailableBalance returns the available balance of the rewarding fund

func (*Protocol) BlockReward 

func (p *Protocol) BlockReward(
	_ context.Context,
	sm protocol.StateManager,
) (*big.Int, error)

BlockReward returns the block reward amount

func (*Protocol) Claim 

func (p *Protocol) Claim(
	ctx context.Context,
	sm protocol.StateManager,
	amount *big.Int,
) error

Claim claims the token from the rewarding fund

func (*Protocol) Deposit added in v0.5.0 

func (p *Protocol) Deposit(
	ctx context.Context,
	sm protocol.StateManager,
	amount *big.Int,
) error

Deposit deposits token into the rewarding fund

func (*Protocol) EpochReward 

func (p *Protocol) EpochReward(
	_ context.Context,
	sm protocol.StateManager,
) (*big.Int, error)

EpochReward returns the epoch reward amount

func (*Protocol) GrantBlockReward 

func (p *Protocol) GrantBlockReward(
	ctx context.Context,
	sm protocol.StateManager,
) error

GrantBlockReward grants the block reward (token) to the block producer

func (*Protocol) GrantEpochReward 

func (p *Protocol) GrantEpochReward(
	ctx context.Context,
	sm protocol.StateManager,
) error

GrantEpochReward grants the epoch reward (token) to all beneficiaries of a epoch

func (*Protocol) Handle 

func (p *Protocol) Handle(
	ctx context.Context,
	act action.Action,
	sm protocol.StateManager,
) (*action.Receipt, error)

Handle handles the actions on the rewarding protocol

func (*Protocol) Initialize 

func (p *Protocol) Initialize(
	ctx context.Context,
	sm protocol.StateManager,
	adminAddr address.Address,
	initBalance *big.Int,
	blockReward *big.Int,
	epochReward *big.Int,
	numDelegatesForEpochReward uint64,
) error

Initialize initializes the rewarding protocol by setting the original admin, block and epoch reward

func (*Protocol) NumDelegatesForEpochReward added in v0.5.0 

func (p *Protocol) NumDelegatesForEpochReward(
	_ context.Context,
	sm protocol.StateManager,
) (uint64, error)

NumDelegatesForEpochReward returns the number of candidates sharing an epoch reward

func (*Protocol) ReadState added in v0.5.0 

func (p *Protocol) ReadState(
	ctx context.Context,
	sm protocol.StateManager,
	method []byte,
	args ...[]byte,
) ([]byte, error)

ReadState read the state on blockchain via protocol

func (*Protocol) SetAdmin 

func (p *Protocol) SetAdmin(
	ctx context.Context,
	sm protocol.StateManager,
	addr address.Address,
) error

SetAdmin sets a new admin address. Only the current admin could make this change

func (*Protocol) SetBlockReward 

func (p *Protocol) SetBlockReward(
	ctx context.Context,
	sm protocol.StateManager,
	amount *big.Int,
) error

SetBlockReward sets the block reward amount for the block rewarding. Only the current admin could make this change

func (*Protocol) SetEpochReward 

func (p *Protocol) SetEpochReward(
	ctx context.Context,
	sm protocol.StateManager,
	amount *big.Int,
) error

SetEpochReward sets the epoch reward amount shared by all beneficiaries in an epoch. Only the current admin could make this change

func (*Protocol) SetNumDelegatesForEpochReward 

func (p *Protocol) SetNumDelegatesForEpochReward(
	ctx context.Context,
	sm protocol.StateManager,
	num uint64,
) error

SetNumDelegatesForEpochReward sets the number of candidates sharing an epoch reward

func (*Protocol) TotalBalance 

func (p *Protocol) TotalBalance(
	ctx context.Context,
	sm protocol.StateManager,
) (*big.Int, error)

TotalBalance returns the total balance of the rewarding fund

func (*Protocol) UnclaimedBalance 

func (p *Protocol) UnclaimedBalance(
	ctx context.Context,
	sm protocol.StateManager,
	addr address.Address,
) (*big.Int, error)

UnclaimedBalance returns unclaimed balance of a given address

func (*Protocol) Validate 

func (p *Protocol) Validate(
	ctx context.Context,
	act action.Action,
) error

Validate validates the actions on the rewarding protocol

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.