core

type ArchitectureHelper struct {
	SpaceLayoutImage   string
	SolarOutputImage   string
	SolarArray         string
	DailyAvgGeneration string
	System             string
	InverterSize       string
	DesignDescription  string
}

type BulletHelper struct {
	Bullet1 string
	Bullet2 string
	Bullet3 string
}

type CommunityEngagementHelper struct {
	Width    int
	Title    string
	ImageURL string
	Content  string
	Link     string
}

type ContractAuction struct {
	// TODO: this struct isn't used yet as it needs handlers and stuff, but when
	// we move off main.go for testing, this must be used in order to make stuff
	// easier for us.
	AllContracts    []Project
	AllContractors  []Entity
	WinningContract Project
}

type Entity struct {
	// U is the base User class inherited from openx
	U *openx.User

	// Contractor is a bool that is set if the entity is a contractor
	Contractor bool

	// Developer is a bool that is set if the entity is a developer
	Developer bool

	// Originator is a bool that is set if the entity is a originator
	Originator bool

	// Guarantor is a bool that is set if the entity is a guarantor
	Guarantor bool

	// PastContracts contains a list of all past contracts associated with the entity
	PastContracts []Project

	// ProposedContracts contains a list of all proposed contracts associated with the entity
	ProposedContracts []Project

	// PresentContracts contains a list of all present contracts associated with the entity
	PresentContracts []Project

	// PastFeedback contains a list of all feedback on the given entity
	PastFeedback []Feedback

	// Collateral is the amount the entity is willing to put up as collateral to secure projects
	Collateral float64

	// CollateralData contains data on the collateral amount that the entity is willing to pledge
	CollateralData []string

	// FirstLossGuarantee is the seed that will be used to transfer funds to investors in case the recipient refuses to pay
	FirstLossGuarantee string

	// 	FirstLossGuaranteeAmt is the amount that the guarantor is expected to cover in the case of a breach
	FirstLossGuaranteeAmt float64
}

type ExecutiveSummaryHelper struct {
	Investment            map[string]string
	Financials            map[string]string
	ProjectSize           map[string]string
	SustainabilityMetrics map[string]string
}

type ExplorePageSummaryHelper struct {
	Solar   string
	Storage string
	Tariff  string
	Stage   int
	Return  string
	Rating  string
	Tax     string
	ETA     int
}

type Feedback struct {
	Content string
	// the content of the feedback, good / bad
	// maybe we could have a rating system baked in? a star based rating system?
	// would be nice, idk
	From Entity
	// who gave the feedback?
	To Entity
	// regarding whom is this feedback about
	Date string
	// time at which this feedback was written
	Contract []Project
}

type FinancialHelper struct {
	Return    float64
	Insurance string
	Tariff    string
	Maturity  string
}

type HashHelper struct {
	LegalProjectOverviewHash string
	LegalPPAHash             string
	LegalRECAgreementHash    string
	GuarantorAgreementHash   string
	ContractorAgreementHash  string
	StakeholderAgreementHash string
	CommunityEnergyHash      string
	FinancialReportingHash   string
}

type InvestmentHelper struct {
	Capex              string
	Hardware           float64
	FirstLossEscrow    string
	CertificationCosts string
}

type Investor struct {
	// U is the base User class inherited from openx
	U *openx.User

	// VotingBalance is the balance associated with the particular investor (equal to the amount of USD he possesses)
	VotingBalance float64

	// AmountInvested is the total amount invested by the investor
	AmountInvested float64

	// InvestedSolarProjects is a list of the investor assets of the opensolar projects the investor has invested in
	InvestedSolarProjects []string

	// InvestedSolarProjectsIndices is an integer list of the projects the investor has invested in
	InvestedSolarProjectsIndices []int

	// InvestedSolarProjects is a list of the investor assets of the opensolar projects the investor has invested in
	SeedInvestedSolarProjects []string

	// InvestedSolarProjectsIndices is an integer list of the projects the investor has invested in
	SeedInvestedSolarProjectsIndices []int

	// WeightedROI is the weighted ROI that the investor is expected to get for his investments
	WeightedROI string

	// AllTimeReturns is the all time returns the investor has realized from his investments
	AllTimeReturns []float64

	// ReceivedRECs is a list of the RECs the recipient has invested in
	ReceivedRECs string

	// Prorata is the pro rata in all the projects that the investor has invested in
	Prorata string
}

type Project struct {
	Index                     int     // an Index to keep track of how many projects exist
	Name                      string  // the name of the project / the identifier by which its referred to
	State                     string  // the state in which the project has been installed in
	Country                   string  // the country in which the project has been installed in
	TotalValue                float64 // the total money that we need from investors
	PanelSize                 string  // size of the given panel, for diplsaying to the user who wants to bid stuff
	PanelTechnicalDescription string  // This should talk about '10x 100W Komaes etc'
	Inverter                  string  // the inverter of the installed project
	ChargeRegulator           string  // the charge regulator of the installed project
	ControlPanel              string  // the control panel of the installed project
	CommBox                   string  // the comm box of the installed project
	ACTransfer                string  // the AC transfer of the installed project
	SolarCombiner             string  // the solar combiner of the installed project
	Batteries                 string  // the batteries of the installed project
	IoTHub                    string  // the IoT Hub installed as part of the project
	Rating                    string  // the rating of the project (Moody's, etc)
	Metadata                  string  // other metadata which does not have an explicit name can be stored here. Used to derive assetIDs

	// Define parameters related to finance
	MoneyRaised          float64 // total money that has been raised until now
	SeedMoneyRaised      float64 // total seed money that has been raised until now
	EstimatedAcquisition int     // the year in which the recipient is expected to repay the initial investment amount by
	BalLeft              float64 // denotes the balance left to pay by the party, percentage raised is not stored in the database since that can be calculated
	InterestRate         float64 // the rate of return for investors
	Tax                  string  // the specifications of the tax system associated with this particular project

	// Define dates of creation and funding
	DateInitiated string // date the project was created on the platform
	DateFunded    string // date that the project completed the stage 4-5 migration
	DateLastPaid  int64  // int64 ie unix time since we need comparisons on this one

	// Define technical parameters
	AuctionType           string  // the type of the auction in question. Default is blind auction unless explicitly mentioned
	InvestmentType        string  // the type of investment - equity crowdfunding, municipal bond, normal crowdfunding, etc defined in models
	PaybackPeriod         int     // the frequency in number of weeks that the recipient has to pay the platform
	Stage                 int     // the stage at which the contract is at, float due to potential support of 0.5 state changes in the future
	InvestorAssetCode     string  // the code of the asset given to investors on investment in the project
	DebtAssetCode         string  // the code of the asset given to recipients on receiving a project
	PaybackAssetCode      string  // the code of the asset given to recipients on receiving a project
	SeedAssetCode         string  // the code of the asset given to seed investors on seed investment in the project
	SeedInvestmentFactor  float64 // the factor that a seed investor's investment is multiplied by in case he does invest at the seed stage
	SeedInvestmentCap     float64 // the max amount that a seed investor can put in a project when it is in its seed stages
	ProposedInvestmentCap float64 // the max amount that an investor can invest in when the project is in its proposed stage (stage 2)
	SelfFund              float64 // the amount that a beneficiary / recipient puts in a project wihtout asking from other investors. This is not included as a seed investment because this would mean the recipient pays his own investment back in the project
	EscrowPubkey          string  // the publickey of the escrow we setup after project investment
	EscrowLock            bool    // used to lock the escrow in case someting goes wrong

	// Describe issuer of security and the broker dealer
	SecurityIssuer string // the issuer of the security
	BrokerDealer   string // the broker dealer associated with the project

	// Define the various entities that are associated with a specific project
	RecipientIndex              int       // The index of the project's recipient
	OriginatorIndex             int       // the originator of the project
	GuarantorIndex              int       // the person guaranteeing the specific project in question
	ContractorIndex             int       // the person with the proposed contract
	MainDeveloperIndex          int       // the main developer of the project
	BlendedCapitalInvestorIndex int       // the index of the blended capital investor
	InvestorIndices             []int     // The various investors who have invested in the project
	SeedInvestorIndices         []int     // Investors who took part before the contract was at stage 3
	RecipientIndices            []int     // the indices of the recipient family (offtakers, beneficiaries, etc)
	DeveloperIndices            []int     // the indices of the developers involved in the project`
	ContractorFee               float64   // fee paid to the contractor from the total fee of the project
	OriginatorFee               float64   // fee paid to the originator included in the total value of the project
	DeveloperFee                []float64 // the fees charged by the developers
	DebtInvestor1               string    // debt investor index, if any
	DebtInvestor2               string    // debt investor index, if any
	TaxEquityInvestor           string    // tax equity investor if any

	// Define parameters that will not be defined directly but will be used for the backend flow
	Lock            bool               // lock investment in order to wait for recipient's confirmation
	LockPwd         string             // the recipient's seedpwd. Will be set to null as soon as we use it.
	Votes           float64            // the number of votes towards a proposed contract by investors
	AmountOwed      float64            // the amoutn owed to investors as a cumulative sum. Used in case of a breach
	Reputation      float64            // the positive reputation associated with a given project
	OwnershipShift  float64            // the percentage of the project that the recipient now owns
	StageData       []string           // the data associated with stage migrations
	StageChecklist  []map[string]bool  // the checklist that has to be completed before moving on to the next stage
	InvestorMap     map[string]float64 // publicKey: percentage donation
	SeedInvestorMap map[string]float64 // the list of all seed investors who've invested in the project
	WaterfallMap    map[string]float64 // publickey:amount map ni order to pay multiple accounts. A bit ugly, but should work fine. Make map before using

	// Define things that will be displayed on the frontend
	Terms               []TermsHelper               // the terms of the project
	ExecutiveSummary    ExecutiveSummaryHelper      // the bigger struct that holds all the executive summary metrics
	AutoReloadInterval  float64                     // the interval in which the user's funds reach zero
	ResilienceRating    float64                     // resilience of the project
	ActionsRequired     string                      // the action(s) required by the user
	Bullets             BulletHelper                // list of bullet points to be displayed on the frontend
	Hashes              HashHelper                  // list of hashes to be displayed on the project details page
	PendingDocuments    map[int]string              // a map of the user id and the document he needs to follow on. This text would match the index map in the user struct
	ContractList        []string                    // the list of contracts to be displayed on the frontend
	Architecture        ArchitectureHelper          // the section labeled "Architecture/Project Design"
	Context             string                      // the section titled "Context"
	SummaryImage        string                      // the url to the image linked in the summary
	CommunityEngagement []CommunityEngagementHelper // the section labelled "Community Engagement" on the frontend
	ExplorePageSummary  ExplorePageSummaryHelper    // the summary on the explore page tab

	EngineeringLayoutType string
	FEText                map[string]interface{} // put all the fe text in here reading it from the relevant json file(s)
	MapLink               string                 // the google maps link to the installation site

	Chain string // the chain on which the project desires to be.
}

type ProjectSizeHelper struct {
	PVSolar          string
	Storage          string
	Critical         float64
	InverterCapacity string
}

type Recipient struct {
	U *openx.User
	// user related functions are called as an instance directly
	ReceivedSolarProjects       []string
	ReceivedSolarProjectIndices []int
	ReceivedConstructionBonds   []string
	// ReceivedProjects denotes the projects that have been received by the recipient
	// instead of storing the PaybackAssets and the DebtAssets, we store this
	DeviceId string
	// the device ID of the associated solar hub. We don't do much with it here,
	// but we need it on the IoT Hub side to check login stuff
	DeviceStarts []string
	// the start time of the devices recorded for reference. We could monitor unscheduled
	// closes on the platform level as well and send email notifications or similar
	DeviceLocation string
	// the location of the device. Teller gets location using google's geolocation
	// API. Accuracy is of the order ~1km radius. Not great, but enough to detect
	// theft or something
	StateHashes []string
	// StateHashes provides the list of state updates (ipfs hashes) that the teller associated with this
	// particular recipient has communicated.
	TotalEnergyCP float64
	// the total energy produced by the recipient's assets in the current period
	TotalEnergy float64
	// the total energy produced by the recipient's assets over all billed periods
	Autoreload bool
}

type SolarProjectArray []Project

type Stage struct {
	Number          int
	FriendlyName    string   // the informal name that one can use while referring to the stage (nice for UI as well)
	Name            string   // this is a more formal name to give to the given stage
	Activities      []string // the activities that are covered in this particular stage and need to be fulfilled in order to move to the next stage.
	StateTrigger    []string // trigger state change from n to n+1
	BreachCondition []string // define breach conditions for a particular stage
}

type SustainabilityHelper struct {
	CarbonDrawdown string
	CommunityValue string
	LCA            string
}

type TermsHelper struct {
	Variable      string
	Value         string
	RelevantParty string
	Note          string
	Status        string
	SupportDoc    string
}