contract

type Bytecode struct {
	EVM      []byte
	ZkSyncVM []byte
}

type DeployInput[ARGS any] struct {
	// ChainSelector is the selector for the chain on which the contract will be deployed.
	// Required to differentiate between operation runs with the same data targeting different chains.
	ChainSelector uint64 `json:"chainSelector"`
	// TypeAndVersion is the desired type and version of the contract to deploy.
	// The deployment operation must define bytecode for this type and version.
	TypeAndVersion deployment.TypeAndVersion `json:"typeAndVersion"`
	// Qualifier is an optional string to differentiate between multiple deployments of
	// the same contract type and version on the same chain. If provided, it is stored
	// in the AddressRef returned by the operation.
	Qualifier *string `json:"qualifier,omitempty"`
	// Args are the parameters passed to the contract constructor.
	Args ARGS `json:"args"`
}

type DeployParams[ARGS any] struct {
	// Name is the name of the operation.
	Name string
	// Version is the version of the operation.
	Version *semver.Version
	// Description is a brief description of the operation.
	Description string
	// ContractMetadata is the metadata from which the ABI is parsed.
	ContractMetadata *bind.MetaData
	// BytecodeByTypeAndVersion is a map of bytecodes for different types and versions of the contract.
	// The key is the string representation of the type and version.
	BytecodeByTypeAndVersion map[string]Bytecode
	// Validate is an optional function to validate the constructor arguments before deployment.
	Validate func(input ARGS) error
}

type ExecInfo struct {
	// Hash is the transaction hash.
	Hash string
}

type FunctionInput[ARGS any] struct {
	// Address defines the contract to call.
	Address common.Address `json:"address"`
	// ChainSelector is the selector for the chain on which the contract resides.
	// Required to differentiate between operation runs with the same data targeting different chains.
	ChainSelector uint64 `json:"chainSelector"`
	// Args are the parameters passed to the contract call.
	Args ARGS `json:"args"`
}

type ReadParams[ARGS any, RET any, C any] struct {
	// Name is the name of the operation.
	Name string
	// Version is the version of the operation.
	Version *semver.Version
	// Description is a brief description of the operation.
	Description string
	// ContractType is the type of contract to read from.
	ContractType cldf_deployment.ContractType
	// NewContract is a function that creates a new instance of the contract binding.
	NewContract func(address common.Address, backend bind.ContractBackend) (C, error)
	// CallContract is a function that calls the desired read function on the contract.
	CallContract func(contract C, opts *bind.CallOpts, input ARGS) (RET, error)
}

type WriteOutput struct {
	// ChainSelector is the selector of the target chain.
	ChainSelector uint64 `json:"chainSelector"`
	// Tx is the prepared transaction (in MCMS format).
	Tx mcms_types.Transaction `json:"tx"`
	// ExecInfo is populated if the write was executed, contains info about the executed transaction.
	ExecInfo *ExecInfo `json:"execInfo,omitempty"`
}

type WriteParams[ARGS any, C any] struct {
	// Name is the name of the operation.
	Name string
	// Version is the version of the operation.
	Version *semver.Version
	// Description is a brief description of the operation.
	Description string
	// ContractType is the type of the target contract.
	ContractType deployment.ContractType
	// ContractABI is the ABI of the target contract.
	ContractABI string
	// NewContract is a function that creates a new instance of the contract binding.
	NewContract func(address common.Address, backend bind.ContractBackend) (C, error)
	// IsAllowedCaller is a function that checks if the caller is allowed to call the function.
	IsAllowedCaller func(contract C, opts *bind.CallOpts, caller common.Address, input ARGS) (bool, error)
	// Validate is a function that validates the input arguments.
	Validate func(input ARGS) error
	// CallContract is a function that calls the desired write method on the contract.
	CallContract func(contract C, opts *bind.TransactOpts, input ARGS) (*eth_types.Transaction, error)
}