stalkproto

package
v0.2.6 Latest Latest
Warning

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

Go to latest
Published: May 30, 2020 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	PricePatterns_name = map[int32]string{
		0: "FLUCTUATING",
		1: "BIGSPIKE",
		2: "DECREASING",
		3: "SMALLSPIKE",
		4: "UNKNOWN",
	}
	PricePatterns_value = map[string]int32{
		"FLUCTUATING": 0,
		"BIGSPIKE":    1,
		"DECREASING":  2,
		"SMALLSPIKE":  3,
		"UNKNOWN":     4,
	}
)

Enum value maps for PricePatterns.

View Source
var (
	ImageFormat_name = map[int32]string{
		0: "SVG",
		1: "PNG",
	}
	ImageFormat_value = map[string]int32{
		"SVG": 0,
		"PNG": 1,
	}
)

Enum value maps for ImageFormat.

View Source
var File_stalk_proto_forecaster_proto protoreflect.FileDescriptor
View Source
var File_stalk_proto_models_proto protoreflect.FileDescriptor

Functions

func RegisterStalkForecasterServer

func RegisterStalkForecasterServer(s *grpc.Server, srv StalkForecasterServer)

Types

type Forecast

type Forecast struct {

	// A summary of the high and low prices for the island.
	PricesSummary *PricesSummary `protobuf:"bytes,1,opt,name=prices_summary,json=pricesSummary,proto3" json:"prices_summary,omitempty"`
	// As prices summary, but for the future and current price periods only.
	PricesFuture *PricesSummary `protobuf:"bytes,4,opt,name=prices_future,json=pricesFuture,proto3" json:"prices_future,omitempty"`
	// Information about spike likelihood and potential periods.
	Spikes *ForecastSpikes `protobuf:"bytes,2,opt,name=spikes,proto3" json:"spikes,omitempty"`
	// Detailed breakdown of each potential price pattern.
	Patterns []*PotentialPattern `protobuf:"bytes,3,rep,name=patterns,proto3" json:"patterns,omitempty"`
	// Score for how hot the investment opportunity is on an island. Used to compare
	// forecasts across islands.
	Heat int32 `protobuf:"varint,5,opt,name=heat,proto3" json:"heat,omitempty"`
	// contains filtered or unexported fields
}

A forecast for prices on your island

func (*Forecast) Descriptor deprecated

func (*Forecast) Descriptor() ([]byte, []int)

Deprecated: Use Forecast.ProtoReflect.Descriptor instead.

func (*Forecast) GetHeat added in v0.2.5

func (x *Forecast) GetHeat() int32

func (*Forecast) GetPatterns

func (x *Forecast) GetPatterns() []*PotentialPattern

func (*Forecast) GetPricesFuture

func (x *Forecast) GetPricesFuture() *PricesSummary

func (*Forecast) GetPricesSummary

func (x *Forecast) GetPricesSummary() *PricesSummary

func (*Forecast) GetSpikes

func (x *Forecast) GetSpikes() *ForecastSpikes

func (*Forecast) ProtoMessage

func (*Forecast) ProtoMessage()

func (*Forecast) ProtoReflect

func (x *Forecast) ProtoReflect() protoreflect.Message

func (*Forecast) Reset

func (x *Forecast) Reset()

func (*Forecast) String

func (x *Forecast) String() string

type ForecastSpikes

type ForecastSpikes struct {

	// The chances of a small spike happening this week.
	Small *SpikeChances `protobuf:"bytes,1,opt,name=small,proto3" json:"small,omitempty"`
	// The chances of a big spike happening this week.
	Big *SpikeChances `protobuf:"bytes,2,opt,name=big,proto3" json:"big,omitempty"`
	// The chances of any spike happening this week.
	Any *SpikeChances `protobuf:"bytes,3,opt,name=any,proto3" json:"any,omitempty"`
	// contains filtered or unexported fields
}

Contains the overall chances of a price spike occurring this week, as well as a breakdown of likelihood for each price period, by spike type.

func (*ForecastSpikes) Descriptor deprecated

func (*ForecastSpikes) Descriptor() ([]byte, []int)

Deprecated: Use ForecastSpikes.ProtoReflect.Descriptor instead.

func (*ForecastSpikes) GetAny

func (x *ForecastSpikes) GetAny() *SpikeChances

func (*ForecastSpikes) GetBig

func (x *ForecastSpikes) GetBig() *SpikeChances

func (*ForecastSpikes) GetSmall

func (x *ForecastSpikes) GetSmall() *SpikeChances

func (*ForecastSpikes) ProtoMessage

func (*ForecastSpikes) ProtoMessage()

func (*ForecastSpikes) ProtoReflect

func (x *ForecastSpikes) ProtoReflect() protoreflect.Message

func (*ForecastSpikes) Reset

func (x *ForecastSpikes) Reset()

func (*ForecastSpikes) String

func (x *ForecastSpikes) String() string

type ImageFormat

type ImageFormat int32

Supported chart image formats

const (
	ImageFormat_SVG ImageFormat = 0
	ImageFormat_PNG ImageFormat = 1
)

func (ImageFormat) Descriptor

func (ImageFormat) Enum

func (x ImageFormat) Enum() *ImageFormat

func (ImageFormat) EnumDescriptor deprecated

func (ImageFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use ImageFormat.Descriptor instead.

func (ImageFormat) Number

func (x ImageFormat) Number() protoreflect.EnumNumber

func (ImageFormat) String

func (x ImageFormat) String() string

func (ImageFormat) Type

type PotentialPattern

type PotentialPattern struct {

	// The price pattern
	Pattern PricePatterns `protobuf:"varint,1,opt,name=pattern,proto3,enum=proto.PricePatterns" json:"pattern,omitempty"`
	// THe chance this price pattern will occur
	Chance float64 `protobuf:"fixed64,2,opt,name=chance,proto3" json:"chance,omitempty"`
	// A summary of the high anf low prices of this pattern
	PricesSummary *PricesSummary `protobuf:"bytes,3,opt,name=prices_summary,json=pricesSummary,proto3" json:"prices_summary,omitempty"`
	// As prices summary, but for the future and current price periods only.
	PricesFuture *PricesSummary `protobuf:"bytes,6,opt,name=prices_future,json=pricesFuture,proto3" json:"prices_future,omitempty"`
	// The range a spike might occur in
	Spike *SpikeRange `protobuf:"bytes,4,opt,name=spike,proto3" json:"spike,omitempty"`
	// A list of potential price permutations this pattern might produce.
	PotentialWeeks []*PotentialWeek `protobuf:"bytes,5,rep,name=potential_weeks,json=potentialWeeks,proto3" json:"potential_weeks,omitempty"`
	// contains filtered or unexported fields
}

Describes the potential course a price pattern may take given the user's price ticker.

func (*PotentialPattern) Descriptor deprecated

func (*PotentialPattern) Descriptor() ([]byte, []int)

Deprecated: Use PotentialPattern.ProtoReflect.Descriptor instead.

func (*PotentialPattern) GetChance

func (x *PotentialPattern) GetChance() float64

func (*PotentialPattern) GetPattern

func (x *PotentialPattern) GetPattern() PricePatterns

func (*PotentialPattern) GetPotentialWeeks

func (x *PotentialPattern) GetPotentialWeeks() []*PotentialWeek

func (*PotentialPattern) GetPricesFuture

func (x *PotentialPattern) GetPricesFuture() *PricesSummary

func (*PotentialPattern) GetPricesSummary

func (x *PotentialPattern) GetPricesSummary() *PricesSummary

func (*PotentialPattern) GetSpike

func (x *PotentialPattern) GetSpike() *SpikeRange

func (*PotentialPattern) ProtoMessage

func (*PotentialPattern) ProtoMessage()

func (*PotentialPattern) ProtoReflect

func (x *PotentialPattern) ProtoReflect() protoreflect.Message

func (*PotentialPattern) Reset

func (x *PotentialPattern) Reset()

func (*PotentialPattern) String

func (x *PotentialPattern) String() string

type PotentialWeek

type PotentialWeek struct {

	// The chance this price fluctuation will occur.
	Chance float64 `protobuf:"fixed64,1,opt,name=chance,proto3" json:"chance,omitempty"`
	// Price information for each price period. Will always have 12 items.
	Prices []*PricePeriod `protobuf:"bytes,3,rep,name=prices,proto3" json:"prices,omitempty"`
	// A summary of the prices in this fluctuation.
	PricesSummary *PricesSummary `protobuf:"bytes,4,opt,name=prices_summary,json=pricesSummary,proto3" json:"prices_summary,omitempty"`
	// As prices summary, but for the future and current price periods only.
	PricesFuture *PricesSummary `protobuf:"bytes,6,opt,name=prices_future,json=pricesFuture,proto3" json:"prices_future,omitempty"`
	// A summary of whether there will be a spike and what periods it will occur on.
	Spike *SpikeRange `protobuf:"bytes,5,opt,name=spike,proto3" json:"spike,omitempty"`
	// contains filtered or unexported fields
}

Describes a potential price fluctuation for a week of a given price pattern.

func (*PotentialWeek) Descriptor deprecated

func (*PotentialWeek) Descriptor() ([]byte, []int)

Deprecated: Use PotentialWeek.ProtoReflect.Descriptor instead.

func (*PotentialWeek) GetChance

func (x *PotentialWeek) GetChance() float64

func (*PotentialWeek) GetPrices

func (x *PotentialWeek) GetPrices() []*PricePeriod

func (*PotentialWeek) GetPricesFuture

func (x *PotentialWeek) GetPricesFuture() *PricesSummary

func (*PotentialWeek) GetPricesSummary

func (x *PotentialWeek) GetPricesSummary() *PricesSummary

func (*PotentialWeek) GetSpike

func (x *PotentialWeek) GetSpike() *SpikeRange

func (*PotentialWeek) ProtoMessage

func (*PotentialWeek) ProtoMessage()

func (*PotentialWeek) ProtoReflect

func (x *PotentialWeek) ProtoReflect() protoreflect.Message

func (*PotentialWeek) Reset

func (x *PotentialWeek) Reset()

func (*PotentialWeek) String

func (x *PotentialWeek) String() string

type PricePatterns

type PricePatterns int32

Enum of the price patterns that can occur in animal crossing.

const (
	PricePatterns_FLUCTUATING PricePatterns = 0
	PricePatterns_BIGSPIKE    PricePatterns = 1
	PricePatterns_DECREASING  PricePatterns = 2
	PricePatterns_SMALLSPIKE  PricePatterns = 3
	PricePatterns_UNKNOWN     PricePatterns = 4
)

func (PricePatterns) Descriptor

func (PricePatterns) Enum

func (x PricePatterns) Enum() *PricePatterns

func (PricePatterns) EnumDescriptor deprecated

func (PricePatterns) EnumDescriptor() ([]byte, []int)

Deprecated: Use PricePatterns.Descriptor instead.

func (PricePatterns) Number

func (PricePatterns) String

func (x PricePatterns) String() string

func (PricePatterns) Type

type PricePeriod

type PricePeriod struct {

	// The minimum price that might occur during this period.
	Min int32 `protobuf:"varint,1,opt,name=min,proto3" json:"min,omitempty"`
	// The maximum price that might occur during this period.
	Max     int32 `protobuf:"varint,2,opt,name=max,proto3" json:"max,omitempty"`
	IsSpike bool  `protobuf:"varint,3,opt,name=is_spike,json=isSpike,proto3" json:"is_spike,omitempty"`
	// contains filtered or unexported fields
}

Price info for a single price period.

func (*PricePeriod) Descriptor deprecated

func (*PricePeriod) Descriptor() ([]byte, []int)

Deprecated: Use PricePeriod.ProtoReflect.Descriptor instead.

func (*PricePeriod) GetIsSpike

func (x *PricePeriod) GetIsSpike() bool

func (*PricePeriod) GetMax

func (x *PricePeriod) GetMax() int32

func (*PricePeriod) GetMin

func (x *PricePeriod) GetMin() int32

func (*PricePeriod) ProtoMessage

func (*PricePeriod) ProtoMessage()

func (*PricePeriod) ProtoReflect

func (x *PricePeriod) ProtoReflect() protoreflect.Message

func (*PricePeriod) Reset

func (x *PricePeriod) Reset()

func (*PricePeriod) String

func (x *PricePeriod) String() string

type PricesSummary

type PricesSummary struct {

	// The absolute minimum price of the parent object.
	Min int32 `protobuf:"varint,1,opt,name=min,proto3" json:"min,omitempty"`
	// The potential maximum price of the parent object.
	Max int32 `protobuf:"varint,2,opt,name=max,proto3" json:"max,omitempty"`
	// The maximum guaranteed price for the parent. This is the minimum highest price
	// we can say will happen with 100% certainty.
	Guaranteed int32 `protobuf:"varint,6,opt,name=guaranteed,proto3" json:"guaranteed,omitempty"`
	// The price periods during which “min“ might occur.
	MinPeriods []int32 `protobuf:"varint,3,rep,packed,name=min_periods,json=minPeriods,proto3" json:"min_periods,omitempty"`
	// The price periods during which “max“ might occur.
	MaxPeriods []int32 `protobuf:"varint,4,rep,packed,name=max_periods,json=maxPeriods,proto3" json:"max_periods,omitempty"`
	// The price periods during which “guaranteed“ might occur.
	GuaranteedPeriods []int32 `protobuf:"varint,5,rep,packed,name=guaranteed_periods,json=guaranteedPeriods,proto3" json:"guaranteed_periods,omitempty"`
	// contains filtered or unexported fields
}

Price info for a series of prices.

func (*PricesSummary) Descriptor deprecated

func (*PricesSummary) Descriptor() ([]byte, []int)

Deprecated: Use PricesSummary.ProtoReflect.Descriptor instead.

func (*PricesSummary) GetGuaranteed

func (x *PricesSummary) GetGuaranteed() int32

func (*PricesSummary) GetGuaranteedPeriods

func (x *PricesSummary) GetGuaranteedPeriods() []int32

func (*PricesSummary) GetMax

func (x *PricesSummary) GetMax() int32

func (*PricesSummary) GetMaxPeriods

func (x *PricesSummary) GetMaxPeriods() []int32

func (*PricesSummary) GetMin

func (x *PricesSummary) GetMin() int32

func (*PricesSummary) GetMinPeriods

func (x *PricesSummary) GetMinPeriods() []int32

func (*PricesSummary) ProtoMessage

func (*PricesSummary) ProtoMessage()

func (*PricesSummary) ProtoReflect

func (x *PricesSummary) ProtoReflect() protoreflect.Message

func (*PricesSummary) Reset

func (x *PricesSummary) Reset()

func (*PricesSummary) String

func (x *PricesSummary) String() string

type ReqForecastChart

type ReqForecastChart struct {

	// Price ticker of the current prices on the island.
	Ticker *Ticker `protobuf:"bytes,1,opt,name=ticker,proto3" json:"ticker,omitempty"`
	// The forecast for future prices on the the island.
	Forecast *Forecast `protobuf:"bytes,2,opt,name=forecast,proto3" json:"forecast,omitempty"`
	// desired image format
	Format ImageFormat `protobuf:"varint,3,opt,name=format,proto3,enum=proto.ImageFormat" json:"format,omitempty"`
	// hex value for the background color of the chart or empty for transparent
	ColorBackground string `protobuf:"bytes,4,opt,name=color_background,json=colorBackground,proto3" json:"color_background,omitempty"`
	// The amount of padding to surround the image with
	Padding float32 `protobuf:"fixed32,5,opt,name=padding,proto3" json:"padding,omitempty"`
	// contains filtered or unexported fields
}

Request message for creating a turnip forecast chart.

func (*ReqForecastChart) Descriptor deprecated

func (*ReqForecastChart) Descriptor() ([]byte, []int)

Deprecated: Use ReqForecastChart.ProtoReflect.Descriptor instead.

func (*ReqForecastChart) GetColorBackground added in v0.2.5

func (x *ReqForecastChart) GetColorBackground() string

func (*ReqForecastChart) GetForecast

func (x *ReqForecastChart) GetForecast() *Forecast

func (*ReqForecastChart) GetFormat

func (x *ReqForecastChart) GetFormat() ImageFormat

func (*ReqForecastChart) GetPadding added in v0.2.5

func (x *ReqForecastChart) GetPadding() float32

func (*ReqForecastChart) GetTicker

func (x *ReqForecastChart) GetTicker() *Ticker

func (*ReqForecastChart) ProtoMessage

func (*ReqForecastChart) ProtoMessage()

func (*ReqForecastChart) ProtoReflect

func (x *ReqForecastChart) ProtoReflect() protoreflect.Message

func (*ReqForecastChart) Reset

func (x *ReqForecastChart) Reset()

func (*ReqForecastChart) String

func (x *ReqForecastChart) String() string

type RespChart

type RespChart struct {

	// Binary image bytes for rendered chart.
	Chart []byte `protobuf:"bytes,1,opt,name=chart,proto3" json:"chart,omitempty"`
	// contains filtered or unexported fields
}

Response message with a rendered svg chart.

func (*RespChart) Descriptor deprecated

func (*RespChart) Descriptor() ([]byte, []int)

Deprecated: Use RespChart.ProtoReflect.Descriptor instead.

func (*RespChart) GetChart

func (x *RespChart) GetChart() []byte

func (*RespChart) ProtoMessage

func (*RespChart) ProtoMessage()

func (*RespChart) ProtoReflect

func (x *RespChart) ProtoReflect() protoreflect.Message

func (*RespChart) Reset

func (x *RespChart) Reset()

func (*RespChart) String

func (x *RespChart) String() string

type SpikeChances

type SpikeChances struct {

	// Whether the parent has this type of spike.
	Has bool `protobuf:"varint,1,opt,name=has,proto3" json:"has,omitempty"`
	// The price period (0-11) the spike might start on.
	Start int32 `protobuf:"varint,2,opt,name=start,proto3" json:"start,omitempty"`
	// The price period (0-11) the spike might end on.
	End int32 `protobuf:"varint,3,opt,name=end,proto3" json:"end,omitempty"`
	// The overall chance this type of spike will occur
	Chance float64 `protobuf:"fixed64,4,opt,name=chance,proto3" json:"chance,omitempty"`
	// A period-by-period breakdown of the chances this type of spike will occur on the
	// given price period.
	Breakdown []float64 `protobuf:"fixed64,5,rep,packed,name=breakdown,proto3" json:"breakdown,omitempty"`
	// contains filtered or unexported fields
}

Spike info for the overall prediction.

func (*SpikeChances) Descriptor deprecated

func (*SpikeChances) Descriptor() ([]byte, []int)

Deprecated: Use SpikeChances.ProtoReflect.Descriptor instead.

func (*SpikeChances) GetBreakdown

func (x *SpikeChances) GetBreakdown() []float64

func (*SpikeChances) GetChance

func (x *SpikeChances) GetChance() float64

func (*SpikeChances) GetEnd

func (x *SpikeChances) GetEnd() int32

func (*SpikeChances) GetHas

func (x *SpikeChances) GetHas() bool

func (*SpikeChances) GetStart

func (x *SpikeChances) GetStart() int32

func (*SpikeChances) ProtoMessage

func (*SpikeChances) ProtoMessage()

func (*SpikeChances) ProtoReflect

func (x *SpikeChances) ProtoReflect() protoreflect.Message

func (*SpikeChances) Reset

func (x *SpikeChances) Reset()

func (*SpikeChances) String

func (x *SpikeChances) String() string

type SpikeRange

type SpikeRange struct {

	// Whether the parent has this type of spike.
	Has bool `protobuf:"varint,1,opt,name=has,proto3" json:"has,omitempty"`
	// The price period (0-11) the spike starts on.
	Start int32 `protobuf:"varint,2,opt,name=start,proto3" json:"start,omitempty"`
	// The price period (0-11) the spike ends on.
	End int32 `protobuf:"varint,3,opt,name=end,proto3" json:"end,omitempty"`
	// contains filtered or unexported fields
}

Spike info for weeks, weeks and patterns.

func (*SpikeRange) Descriptor deprecated

func (*SpikeRange) Descriptor() ([]byte, []int)

Deprecated: Use SpikeRange.ProtoReflect.Descriptor instead.

func (*SpikeRange) GetEnd

func (x *SpikeRange) GetEnd() int32

func (*SpikeRange) GetHas

func (x *SpikeRange) GetHas() bool

func (*SpikeRange) GetStart

func (x *SpikeRange) GetStart() int32

func (*SpikeRange) ProtoMessage

func (*SpikeRange) ProtoMessage()

func (*SpikeRange) ProtoReflect

func (x *SpikeRange) ProtoReflect() protoreflect.Message

func (*SpikeRange) Reset

func (x *SpikeRange) Reset()

func (*SpikeRange) String

func (x *SpikeRange) String() string

type StalkForecasterClient

type StalkForecasterClient interface {
	// Returns a turnip price forecast for supplied price ticker.
	ForecastPrices(ctx context.Context, in *Ticker, opts ...grpc.CallOption) (*Forecast, error)
}

StalkForecasterClient is the client API for StalkForecaster service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type StalkForecasterServer

type StalkForecasterServer interface {
	// Returns a turnip price forecast for supplied price ticker.
	ForecastPrices(context.Context, *Ticker) (*Forecast, error)
}

StalkForecasterServer is the server API for StalkForecaster service.

type Ticker

type Ticker struct {

	// The purchase price of the turnips on sunday.
	PurchasePrice int32 `protobuf:"varint,1,opt,name=purchase_price,json=purchasePrice,proto3" json:"purchase_price,omitempty"`
	// The pattern of the previous week's prices for this island.
	PreviousPattern PricePatterns `` /* 132-byte string literal not displayed */
	// The known nook prices for bells. This is expected to be a 12-value array with
	// a price of '0' standing in for "unknown". If this field contains less than
	// 12 values, it is assumed the remaining values are 0. The server will reject a
	// ticker with less than 12 values
	Prices []int32 `protobuf:"varint,3,rep,packed,name=prices,proto3" json:"prices,omitempty"`
	// The current price period on the target island.
	CurrentPeriod int32 `protobuf:"varint,4,opt,name=current_period,json=currentPeriod,proto3" json:"current_period,omitempty"`
	// contains filtered or unexported fields
}

Island price data sent when requesting a prediction

func (*Ticker) Descriptor deprecated

func (*Ticker) Descriptor() ([]byte, []int)

Deprecated: Use Ticker.ProtoReflect.Descriptor instead.

func (*Ticker) GetCurrentPeriod

func (x *Ticker) GetCurrentPeriod() int32

func (*Ticker) GetPreviousPattern

func (x *Ticker) GetPreviousPattern() PricePatterns

func (*Ticker) GetPrices

func (x *Ticker) GetPrices() []int32

func (*Ticker) GetPurchasePrice

func (x *Ticker) GetPurchasePrice() int32

func (*Ticker) ProtoMessage

func (*Ticker) ProtoMessage()

func (*Ticker) ProtoReflect

func (x *Ticker) ProtoReflect() protoreflect.Message

func (*Ticker) Reset

func (x *Ticker) Reset()

func (*Ticker) String

func (x *Ticker) String() string

type UnimplementedStalkForecasterServer

type UnimplementedStalkForecasterServer struct {
}

UnimplementedStalkForecasterServer can be embedded to have forward compatible implementations.

func (*UnimplementedStalkForecasterServer) ForecastPrices

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL