standards

type ConfidenceLevel int

type ConfidenceThreshold float64

type Contract struct {
	// Standard holds the details of the contract standard.
	Standard ContractStandard
}

type ContractMatcher struct {
	// Name of the contract.
	Name string `json:"name"`

	// Functions is a slice of Function structs, representing the functions defined in the contract standard.
	Functions []Function `json:"functions"`

	// Events is a slice of Event structs, representing the events defined in the contract standard.
	Events []Event `json:"events"`
}

type ContractStandard struct {
	// Name specifies the name of the contract standard, e.g., "ERC-20 Token Standard".
	Name string `json:"name"`

	// Url specifies the URL of the contract standard, e.g., "https://eips.ethereum.org/EIPS/eip-20".
	Url string `json:"url"`

	// Type specifies the type of the contract standard, e.g., ERC20 or ERC721.
	Type Standard `json:"type"`

	// Stagnant indicates whether the contract standard is stagnant in terms of development.
	Stagnant bool `json:"stagnant"`

	// ABI specifies the ABI of the contract standard.
	ABI string `json:"abi"`

	// Functions is a slice of Function structs, representing the functions defined in the contract standard.
	Functions []Function `json:"functions"`

	// Events is a slice of Event structs, representing the events defined in the contract standard.
	Events []Event `json:"events"`
}

type Discovery struct {
	// Confidence specifies the confidence level of the discovery.
	Confidence ConfidenceLevel `json:"confidence"`

	// ConfidencePoints specifies the confidence points of the discovery.
	ConfidencePoints float64 `json:"confidence_points"`

	// Threshold specifies the threshold level of the discovery.
	Threshold ConfidenceThreshold `json:"threshold"`

	// MaximumTokens specifies the maximum number of tokens in the standard.
	// This is basically a standard TokenCount() function response value.
	MaximumTokens int `json:"maximum_tokens"`

	// DiscoverdTokens specifies the number of tokens discovered in the standard.
	// The more tokens discovered, the higher the confidence level.
	DiscoveredTokens int `json:"discovered_tokens"`

	// ContractStandard that is being scanned.
	Standard Standard `json:"standard"`

	// Contract that is being scanned including mathed functions and events.
	Contract *ContractMatcher `json:"contract"`
}

type EIP interface {
	// GetName returns the name of the Ethereum standard, e.g., "ERC-20 Token Standard".
	GetName() string

	// GetType returns the type of the Ethereum standard, e.g., ERC20 or ERC721.
	GetType() Standard

	// GetFunctions returns a slice of Function structs, representing the
	// functions defined in the Ethereum standard.
	GetFunctions() []Function

	// GetUrl returns the URL of the Ethereum standard.
	GetUrl() string

	// IsStagnant returns a boolean indicating whether the Ethereum standard is stagnant.
	IsStagnant() bool

	// GetEvents returns a slice of Event structs, representing the
	// events defined in the Ethereum standard.
	GetEvents() []Event

	// GetStandard returns the complete representation of the Ethereum standard.
	GetStandard() ContractStandard

	// ConfidenceCheck returns a discovery confidence information and a boolean indicating whether
	// the contract is to any level compliant with the Ethereum standard.
	ConfidenceCheck(contract *ContractMatcher) (Discovery, bool)

	// TokenCount returns the number of tokens associated with the Ethereum standard.
	TokenCount() int

	// GetABI returns the ABI of the Ethereum standard.
	GetABI() string

	// ToProto converts the Ethereum standard to its protobuf representation.
	ToProto() *eip_pb.ContractStandard

	// String returns a string representation of the Ethereum standard, typically its name.
	String() string
}

type Event struct {
	// Name specifies the name of the event.
	Name string `json:"name"`

	// Inputs is a slice of Input structs, representing the input parameters of the event.
	Inputs []Input `json:"inputs"`

	// Outputs is a slice of Output structs, representing the data types of the event's return values.
	Outputs []Output `json:"outputs"`

	// Matched indicates whether the input has been matched via confidence check.
	Matched bool `json:"matched"`
}

type Function struct {
	// Name specifies the name of the function.
	Name string `json:"name"`

	// Inputs is a slice of Input structs, representing the input parameters of the function.
	Inputs []Input `json:"inputs"`

	// Outputs is a slice of Output structs, representing the data types of the function's return values.
	Outputs []Output `json:"outputs"`

	// Matched indicates whether the input has been matched via confidence check.
	Matched bool `json:"matched"`
}

type Input struct {
	// Type specifies the Ethereum data type of the input.
	Type string `json:"type"`

	// Indexed indicates whether the input is indexed.
	// This is particularly relevant for event parameters,
	// where indexed parameters can be used as a filter for event logs.
	Indexed bool `json:"indexed"`

	// Matched indicates whether the input has been matched via confidence check.
	Matched bool `json:"matched"`
}

type Output struct {
	// Type specifies the Ethereum data type of the output.
	Type string `json:"type"`

	// Matched indicates whether the output has been matched via confidence check.
	Matched bool `json:"matched"`
}

type Standard string