referral

Documentation

Index

• Constants
• Variables
• type Broker
• type Engine
  • func NewEngine(broker Broker, timeSvc TimeService, mat MarketActivityTracker, ...) *Engine
  • func (e *Engine) ApplyReferralCode(ctx context.Context, party types.PartyID, setID types.ReferralSetID) error
  • func (e *Engine) CheckSufficientBalanceForApplyReferralCode(party types.PartyID, balance *num.Uint) error
  • func (e *Engine) CreateReferralSet(ctx context.Context, party types.PartyID, ...) error
  • func (e *Engine) GetReferrer(referee types.PartyID) (types.PartyID, error)
  • func (e *Engine) HasProgramEnded() bool
  • func (e *Engine) OnEpoch(ctx context.Context, ep types.Epoch)
  • func (e *Engine) OnEpochRestore(_ context.Context, ep types.Epoch)
  • func (e *Engine) OnMinBalanceForApplyReferralCodeUpdated(_ context.Context, min *num.Uint) error
  • func (e *Engine) OnReferralProgramMaxPartyNotionalVolumeByQuantumPerEpochUpdate(_ context.Context, value *num.Uint) error
  • func (e *Engine) OnReferralProgramMaxReferralRewardProportionUpdate(_ context.Context, value num.Decimal) error
  • func (e *Engine) OnReferralProgramMinStakedVegaTokensUpdate(_ context.Context, value *num.Uint) error
  • func (e *Engine) ReferralDiscountFactorForParty(party types.PartyID) num.Decimal
  • func (e *Engine) RewardsFactorForParty(party types.PartyID) num.Decimal
  • func (e *Engine) RewardsFactorMultiplierAppliedForParty(party types.PartyID) num.Decimal
  • func (e *Engine) RewardsMultiplierForParty(party types.PartyID) num.Decimal
  • func (e *Engine) SetExists(setID types.ReferralSetID) bool
  • func (e *Engine) UpdateProgram(newProgram *types.ReferralProgram)
• type EpochEngine
• type MarketActivityTracker
• type SnapshottedEngine
  • func NewSnapshottedEngine(broker Broker, timeSvc TimeService, mat MarketActivityTracker, ...) *SnapshottedEngine
  • func (e *SnapshottedEngine) GetState(k string) ([]byte, []types.StateProvider, error)
  • func (e *SnapshottedEngine) Keys() []string
  • func (e *SnapshottedEngine) LoadState(_ context.Context, p *types.Payload) ([]types.StateProvider, error)
  • func (e *SnapshottedEngine) Namespace() types.SnapshotNamespace
  • func (e *SnapshottedEngine) StopSnapshots()
  • func (e *SnapshottedEngine) Stopped() bool
• type StakingBalances
• type TimeService

Constants

const MaximumWindowLength uint64 = 100

Variables

var (
	ErrIsAlreadyAReferee = func(party types.PartyID) error {
		return fmt.Errorf("party %q has already been referred", party)
	}

	ErrIsAlreadyAReferrer = func(party types.PartyID) error {
		return fmt.Errorf("party %q is already a referrer", party)
	}

	ErrUnknownReferralCode = func(code types.ReferralSetID) error {
		return fmt.Errorf("no referral set for referral code %q", code)
	}

	ErrNotEligibleForReferralRewards = func(party string, balance, required *num.Uint) error {
		return fmt.Errorf("party %q not eligible for referral rewards, staking balance required of %s got %s", party, required.String(), balance.String())
	}

	ErrNotPartOfAReferralSet = func(party types.PartyID) error {
		return fmt.Errorf("party %q is not part of a referral set", party)
	}

	ErrUnknownSetID = errors.New("unknown set ID")
)

Types

type Broker

type Broker interface {
	Send(events.Event)
}

Broker is used to notify administrative actions on teams and members.

type Engine

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

func NewEngine

func NewEngine(broker Broker, timeSvc TimeService, mat MarketActivityTracker, staking StakingBalances) *Engine

func (*Engine) ApplyReferralCode

func (e *Engine) ApplyReferralCode(ctx context.Context, party types.PartyID, setID types.ReferralSetID) error

func (*Engine) CheckSufficientBalanceForApplyReferralCode

func (e *Engine) CheckSufficientBalanceForApplyReferralCode(party types.PartyID, balance *num.Uint) error

func (*Engine) CreateReferralSet

func (e *Engine) CreateReferralSet(ctx context.Context, party types.PartyID, deterministicSetID types.ReferralSetID) error

func (*Engine) GetReferrer

func (e *Engine) GetReferrer(referee types.PartyID) (types.PartyID, error)

func (*Engine) HasProgramEnded

func (e *Engine) HasProgramEnded() bool

func (*Engine) OnEpoch

func (e *Engine) OnEpoch(ctx context.Context, ep types.Epoch)

func (*Engine) OnEpochRestore

func (e *Engine) OnEpochRestore(_ context.Context, ep types.Epoch)

func (*Engine) OnMinBalanceForApplyReferralCodeUpdated

func (e *Engine) OnMinBalanceForApplyReferralCodeUpdated(_ context.Context, min *num.Uint) error

func (*Engine) OnReferralProgramMaxPartyNotionalVolumeByQuantumPerEpochUpdate

func (e *Engine) OnReferralProgramMaxPartyNotionalVolumeByQuantumPerEpochUpdate(_ context.Context, value *num.Uint) error

func (*Engine) OnReferralProgramMaxReferralRewardProportionUpdate

func (e *Engine) OnReferralProgramMaxReferralRewardProportionUpdate(_ context.Context, value num.Decimal) error

func (*Engine) OnReferralProgramMinStakedVegaTokensUpdate

func (e *Engine) OnReferralProgramMinStakedVegaTokensUpdate(_ context.Context, value *num.Uint) error

func (*Engine) ReferralDiscountFactorForParty

func (e *Engine) ReferralDiscountFactorForParty(party types.PartyID) num.Decimal

func (*Engine) RewardsFactorForParty

func (e *Engine) RewardsFactorForParty(party types.PartyID) num.Decimal

func (*Engine) RewardsFactorMultiplierAppliedForParty

func (e *Engine) RewardsFactorMultiplierAppliedForParty(party types.PartyID) num.Decimal

func (*Engine) RewardsMultiplierForParty

func (e *Engine) RewardsMultiplierForParty(party types.PartyID) num.Decimal

func (*Engine) SetExists

func (e *Engine) SetExists(setID types.ReferralSetID) bool

func (*Engine) UpdateProgram

func (e *Engine) UpdateProgram(newProgram *types.ReferralProgram)

type EpochEngine

type EpochEngine interface {
	NotifyOnEpoch(func(context.Context, types.Epoch), func(context.Context, types.Epoch))
}

EpochEngine is used to know when to apply the team switches.

type MarketActivityTracker

type MarketActivityTracker interface {
	NotionalTakerVolumeForParty(string) *num.Uint
}

MarketActivityTracker is used to retrieve the trading statistics about a party to compute referral program related data.

type SnapshottedEngine

type SnapshottedEngine struct {
	*Engine
	// contains filtered or unexported fields
}

func NewSnapshottedEngine

func NewSnapshottedEngine(broker Broker, timeSvc TimeService, mat MarketActivityTracker, staking StakingBalances) *SnapshottedEngine

func (*SnapshottedEngine) GetState

func (e *SnapshottedEngine) GetState(k string) ([]byte, []types.StateProvider, error)

func (*SnapshottedEngine) Keys

func (e *SnapshottedEngine) Keys() []string

func (*SnapshottedEngine) LoadState

func (e *SnapshottedEngine) LoadState(_ context.Context, p *types.Payload) ([]types.StateProvider, error)

func (*SnapshottedEngine) Namespace

func (e *SnapshottedEngine) Namespace() types.SnapshotNamespace

func (*SnapshottedEngine) StopSnapshots

func (e *SnapshottedEngine) StopSnapshots()

func (*SnapshottedEngine) Stopped

func (e *SnapshottedEngine) Stopped() bool

type StakingBalances

type StakingBalances interface {
	GetAvailableBalance(party string) (*num.Uint, error)
}

type TimeService

type TimeService interface {
	GetTimeNow() time.Time
}