capabilities

type ActionCapability interface {
	ExecutableCapability
}

type BaseCapability interface {
	Info(ctx context.Context) (CapabilityInfo, error)
}

type CapabilityConfiguration struct {
	DefaultConfig *values.Map
	// RestrictedKeys is a list of keys that can't be provided by users in their
	// configuration; we'll remove these fields before passing them to the capability.
	RestrictedKeys []string
	// RestrictedConfig is configuration that can only be set by us; this
	// takes precedence over any user-provided config.
	RestrictedConfig       *values.Map
	RemoteTriggerConfig    *RemoteTriggerConfig
	RemoteTargetConfig     *RemoteTargetConfig
	RemoteExecutableConfig *RemoteExecutableConfig
}

type CapabilityInfo struct {
	// The capability ID is a fully qualified identifier for the capability.
	//
	// It takes the form of `{name}:{label1_key}_{labe1_value}:{label2_key}_{label2_value}@{version}`
	//
	// The labels within the ID are ordered alphanumerically.
	ID             string
	CapabilityType CapabilityType
	Description    string
	DON            *DON
	IsLocal        bool
}

type CapabilityRequest struct {
	Metadata RequestMetadata
	Config   *values.Map
	Inputs   *values.Map
}

type CapabilityResponse struct {
	Value    *values.Map
	Metadata ResponseMetadata
}

type CapabilityType string

type ConsensusCapability interface {
	ExecutableCapability
}

type DON struct {
	ID               uint32
	ConfigVersion    uint32
	Members          []p2ptypes.PeerID
	F                uint8
	IsPublic         bool
	AcceptsWorkflows bool
}

type Executable interface {
	RegisterToWorkflow(ctx context.Context, request RegisterToWorkflowRequest) error
	UnregisterFromWorkflow(ctx context.Context, request UnregisterFromWorkflowRequest) error
	Execute(ctx context.Context, request CapabilityRequest) (CapabilityResponse, error)
}

type ExecutableCapability interface {
	BaseCapability
	Executable
}

type MeteringNodeDetail struct {
	Peer2PeerID string
	SpendUnit   string
	SpendValue  string
}

type Node struct {
	PeerID         *p2ptypes.PeerID
	WorkflowDON    DON
	CapabilityDONs []DON
}

type OCRAttributedOnchainSignature struct {
	Signature []byte
	Signer    uint32 // oracle ID (0,1,...,N-1)
}

type OCRTriggerEvent struct {
	ConfigDigest []byte
	SeqNr        uint64
	Report       []byte // marshaled pb.OCRTriggerReport
	Sigs         []OCRAttributedOnchainSignature
}

type RegisterToWorkflowRequest struct {
	Metadata RegistrationMetadata
	Config   *values.Map
}

type RegistrationMetadata struct {
	WorkflowID    string
	WorkflowOwner string
	// The step reference ID of the workflow
	ReferenceID string
}

type RemoteExecutableConfig struct {
	RequestHashExcludedAttributes []string
	RegistrationRefresh           time.Duration
	RegistrationExpiry            time.Duration
}

type RemoteTargetConfig struct {
	RequestHashExcludedAttributes []string
}

type RemoteTriggerConfig struct {
	RegistrationRefresh     time.Duration
	RegistrationExpiry      time.Duration
	MinResponsesToAggregate uint32
	MessageExpiry           time.Duration
	MaxBatchSize            uint32
	BatchCollectionPeriod   time.Duration
}

type RequestMetadata struct {
	WorkflowID               string
	WorkflowOwner            string
	WorkflowExecutionID      string
	WorkflowName             string
	WorkflowDonID            uint32
	WorkflowDonConfigVersion uint32
	// The step reference ID of the workflow
	ReferenceID string
	// Use DecodedWorkflowName if the human readable name needs to be exposed, such as for logging purposes.
	DecodedWorkflowName string
}

type ResponseMetadata struct {
	Metering []MeteringNodeDetail
}

type TargetCapability interface {
	ExecutableCapability
}

type TriggerCapability interface {
	BaseCapability
	TriggerExecutable
}

type TriggerEvent struct {
	// The ID of the trigger capability
	TriggerType string
	// The ID of the trigger event
	ID string
	// Trigger-specific payload
	Outputs *values.Map
	// Deprecated: use Outputs instead
	// TODO: remove after core services are updated (pending https://github.com/smartcontractkit/chainlink/pull/16950)
	OCREvent *OCRTriggerEvent
}

type TriggerExecutable interface {
	RegisterTrigger(ctx context.Context, request TriggerRegistrationRequest) (<-chan TriggerResponse, error)
	UnregisterTrigger(ctx context.Context, request TriggerRegistrationRequest) error
}

type TriggerRegistrationRequest struct {
	// TriggerID uniquely identifies the trigger by concatenating
	// the workflow ID and the trigger's index in the spec.
	TriggerID string

	Metadata RequestMetadata
	Config   *values.Map
}

type TriggerResponse struct {
	Event TriggerEvent
	Err   error
}

type UnregisterFromWorkflowRequest struct {
	Metadata RegistrationMetadata
	Config   *values.Map
}

type Validatable interface {
	// ValidateSchema returns the JSON schema for the capability.
	//
	// This schema includes the configuration, input and output schemas.
	Schema() (string, error)
}

type Validator[Config any, Inputs any, Outputs any] struct {
	ValidatorArgs
	// contains filtered or unexported fields
}

type ValidatorArgs struct {
	Info CapabilityInfo

	// You can customize each one of the reflectors
	// or leave them nil to use the default reflector.
	//
	// You can also override the default reflector by setting
	// the DefaultReflector field.
	DefaultReflector *jsonschema.Reflector

	SchemaReflector  *jsonschema.Reflector
	ConfigReflector  *jsonschema.Reflector
	InputsReflector  *jsonschema.Reflector
	OutputsReflector *jsonschema.Reflector
}