workflow

type ChildStepRelation struct {
	// ID is the child step ID.
	ID string `json:"id" validate:"required"`

	// ExecuteOnError contains a boolean value to identify whether the child
	// step must be executed if the current one is failed.
	ExecuteOnError bool `json:"executeOnError,omitempty"`

	// Conditions contains a list of conditions that must be met in order to execute the child step.
	Conditions []Condition `json:"conditions,omitempty" validate:"lt=100,dive"`
}

type Condition struct {
	// Type contains a condition type.
	Type ConditionType `json:"type" validate:"required,condition_type"`

	// Pure contains pure condition.
	Pure *ConditionPure `json:"pure,omitempty" validate:"required_if=Type PURE"`

	// Group contains condition group.
	Group *ConditionGroup `json:"group,omitempty" validate:"required_if=Type GROUP"`
}

type ConditionGroup struct {
	// Operator is the condition operator that will be applied to the whole group of conditions.
	// I.e. if operator is "AND" then all conditions in the group must be met.
	Operator ConditionOperator `json:"operator" validate:"required,condition_operator"`

	// Conditions is the list of group's conditions.
	Conditions []Condition `json:"conditions" validate:"lt=100,dive"`
}

type ConditionOperator string

type ConditionPure struct {
	// Left contains a left part of a condition
	Left interface{} `json:"left" validate:"required"`

	// Operator is the condition comparison operator.
	// TODO: Add validation: == <= >= <>
	Operator string `json:"operator" validate:"required"`

	// Right contains a right part of a condition
	Right interface{} `json:"right" validate:"required"`
}

type ConditionType string

type ParentStepRelation struct {
	// ID is the parent step ID.
	ID string `json:"id" validate:"required"`

	// ExecuteOnError contains a boolean value to identify whether the current
	// step must be executed if the parent one is failed.
	ExecuteOnError bool `json:"executeOnError,omitempty"`
}

type Step struct {
	// ID contains step identifier
	ID string `json:"id" validate:"required"`

	// Type is the typ of the current step.
	// The value of this field identifies which of the fields below is not empty.
	Type StepType `json:"type" validate:"required,step_type"`

	// Name is the step name
	Name string `json:"name,omitempty"`

	TriggerConfig   *StepTriggerConfig   `json:"triggerConfig,omitempty" validate:"required_if=Type TRIGGER"`
	ActionConfig    *StepActionConfig    `json:"actionConfig,omitempty" validate:"required_if=Type ACTION"`
	ConditionConfig *StepConditionConfig `json:"conditionConfig,omitempty" validate:"required_if=Type CONDITION"`
	ExitConfig      *StepExitConfig      `json:"exitConfig,omitempty" validate:"required_if=Type EXIT"`

	// ParentSteps contains parent steps dependencies
	ParentSteps []ParentStepRelation `json:"parentSteps,omitempty" validate:"lt=100,dive"`

	// ChildSteps contains child steps dependencies
	ChildSteps []ChildStepRelation `json:"childSteps,omitempty" validate:"lt=100,dive"`

	// ExitOnError contains a boolean value to identify whether a workflow
	// must be failed if this particular step is failed.
	ExitOnError bool `json:"exitOnError,omitempty"`

	// Metadata contains any data.
	// This is basically used by the UI side for visualization.
	Metadata map[string]interface{} `json:"metadata"`
}

type StepActionConfig struct {
	// Kind is the kind of action
	Kind StepActionKind `json:"kind" validate:"required"`

	// OutputField is the name of the field that contains a step's results.
	OutputField string `json:"outputField" validate:"variable"`

	// EthCallParams contains an ath_call event parameters.
	EthCallParams *StepActionEthCallParams `json:"ethCallParams,omitempty"`

	// EthTxParams contains an eth tx action parameters.
	EthTxParams *StepActionEthTxParams `json:"ethTxParams,omitempty"`
}

type StepActionEthCallParams struct {
	// ChainID is the chain ID of the contract
	ChainID uint64 `json:"chainID" validate:"required"`

	// Contract is the contract address for making eth_call
	Contract string `json:"contract" validate:"required,eth_addr"`

	// FuncAbi is the function ABI. E.g. "checkUpkeep(bytes data) returns (bool, bytes)"
	FuncAbi string `json:"funcABI" validate:"required"`

	// Params is the params mapping based on the function ABI
	Params map[string]interface{} `json:"params"`

	// GasLimit is the gas limit for the eth_call
	GasLimit uint64 `json:"gasLimit"`
}

type StepActionEthTxParams struct {
	// ChainID is the chain ID of the contract
	ChainID uint64 `json:"chainID" validate:"required"`

	// Contract is the contract address for sending tx
	Contract string `json:"contract" validate:"required,eth_addr"`

	// FuncAbi is the function ABI. E.g. "performUpkeep(bytes performData)"
	FuncAbi string `json:"funcABI" validate:"required"`

	// Params is the params mapping based on the function ABI
	Params map[string]interface{} `json:"params"`

	// GasLimit is the gas limit for the tx
	GasLimit uint64 `json:"gasLimit"`
}

type StepActionKind string

type StepConditionConfig struct {
	// OutputField is the name of the field that contains a step's results.
	OutputField string `json:"outputField" validate:"required,variable"`

	// Condition contains condition data.
	Condition Condition `json:"condition"`
}

type StepExitConfig struct {
	// Notes contains exit step notes
	Notes string `json:"notes,omitempty"`
}

type StepTriggerBlockParams struct {
	// ChainID is the chain ID the trigger is related to
	ChainID uint64 `json:"chainID" validate:"required"`

	// Period is the period of the block trigger. E.g. n, 2n, 3n, 5n, etc.
	Period string `json:"period" validate:"required"`
}

type StepTriggerConfig struct {
	// Kind is the kind of trigger
	Kind StepTriggerKind `json:"kind" validate:"required,trigger_type"`

	// OutputField is the name of the field that contains a step's results.
	OutputField string `json:"outputField" validate:"required,variable"`

	// BlockParams contains a block trigger parameters.
	BlockParams *StepTriggerBlockParams `json:"blockParams,omitempty" validate:"required_if=Kind BLOCK"`

	// EventParams contains a event trigger parameters.
	EventParams *StepTriggerEventParams `json:"eventParams,omitempty" validate:"required_if=Kind EVENT"`

	// CronParams contains a cron trigger parameters.
	CronParams *StepTriggerCronParams `json:"cronParams,omitempty" validate:"required_if=Kind CRON"`
}

type StepTriggerCronParams struct {
	// Rule is the cron rule, e.g. "0 * * * *"
	Rule string `json:"rule" validate:"required,cron"`
}

type StepTriggerEventParams struct {
	// ChainID is the chain ID the trigger is related to
	ChainID uint64 `json:"chainID"`

	// Contract is the contract address that emmits an event
	Contract string `json:"contract"`

	// EventABI is the event ABI, e.g. "TriggerPerformance(bytes,bool)"
	// It should be provided if topicID is empty
	EventABI *string `json:"eventABI" validate:"required_without=TopicID" `

	// TopicID is the topic ID that starts from 0x...
	// It should be provided if eventABI is empty
	TopicID *string `json:"topicID" validate:"required_without=EventABI,hexadecimal" `
}

type StepTriggerKind string

type StepType string

type Workflow struct {
	// ID is the workflow identifier
	ID string `json:"id" validate:"required"`

	// Steps list of the workflow
	Steps []Step `json:"steps" validate:"dive"`

	// Metadata contains any data.
	// This is basically used by the UI side for visualization.
	Metadata map[string]interface{} `json:"metadata"`
}