runtime

README

runtime

Cryptellation RunTime Library

Documentation

Index

• Variables
• func WithMode(ctx workflow.Context, mode Mode) workflow.Context
• type CallbackWorkflow
• type Callbacks
• type Mode
  • func GetMode(ctx workflow.Context) Mode
  • func (m Mode) String() string
  • func (m Mode) Validate() error
• type OnExitCallbackWorkflowParams
• type OnInitCallbackWorkflowParams
• type OnNewPricesCallbackWorkflowParams
• type Run

Variables

var (
	// ErrInvalidMode is returned when the mode is invalid.
	ErrInvalidMode = errors.New("invalid mode")
)

Functions

func WithMode

func WithMode(ctx workflow.Context, mode Mode) workflow.Context

WithMode sets the mode in the context.

Types

type CallbackWorkflow

type CallbackWorkflow struct {
	Name             string
	TaskQueueName    string
	ExecutionTimeout time.Duration
}

CallbackWorkflow is the parameters of a callback workflow.

type Callbacks

type Callbacks struct {
	OnInitCallback      CallbackWorkflow
	OnNewPricesCallback CallbackWorkflow
	OnExitCallback      CallbackWorkflow
}

Callbacks is the struct representing callbacks for ans automation through cryptellation API.

type Mode

type Mode string

Mode is the mode in which a run is executed.

const (
	// ModeBacktest is the backtest mode.
	ModeBacktest Mode = "backtest"
	// ModeForwardtest is the forwardtest mode.
	ModeForwardtest Mode = "forwardtest"
	// ModeLive is the live mode.
	ModeLive Mode = "live"
)

func GetMode

func GetMode(ctx workflow.Context) Mode

GetMode returns the mode from the context.

func (Mode) String

func (m Mode) String() string

String returns the string representation of the mode.

func (Mode) Validate

func (m Mode) Validate() error

Validate validates the mode.

type OnExitCallbackWorkflowParams

type OnExitCallbackWorkflowParams struct {
	Run Run
}

OnExitCallbackWorkflowParams is the parameters of the OnExitCallbackWorkflow callback workflow.

type OnInitCallbackWorkflowParams

type OnInitCallbackWorkflowParams struct {
	Run Run
}

OnInitCallbackWorkflowParams is the parameters of the OnInitCallbackWorkflow callback workflow.

type OnNewPricesCallbackWorkflowParams

type OnNewPricesCallbackWorkflowParams struct {
	Run   Run
	Ticks []tick.Tick
}

OnNewPricesCallbackWorkflowParams is the parameters of the OnNewPricesCallbackWorkflow callback workflow.

type Run

type Run struct {
	// ID is the ID of the run that corresponds to a backtest, a forwardtest or a live run.
	ID uuid.UUID
	// Mode is the mode of the run (backtests, forwardtest or live run).
	Mode Mode
	// Now is the time of the run.
	// It is used to simulate the time of the run for backtests.
	// On forwardtests and live runs, it is the current time.
	Now time.Time
	// ParentTaskQueue is the task queue of the parent workflow.
	// It's the one that called the callback.
	ParentTaskQueue string
}

Run is the context of a run that contains several information about the run.