core

type CMS struct {
	Keys    []string // the keys of the map at level 1
	Details map[string]map[string]interface{}
}

type Company struct {
	// CompanyType is the type of the company
	CompanyType string

	// Name is the name of the company
	Name string

	// LegalName is the legal name of the company
	LegalName string

	// AdminEmail is the email of the admin / contact point of the company
	AdminEmail string

	// PhoneNumber is the phone number of the main contact in the company
	PhoneNumber string

	// Address is the registered address of the company
	Address string

	// Country is the country where the company is registered in
	Country string

	// City is the city in which the company is registered at
	City string

	// ZipCode is the zipcode of the city where the company is at
	ZipCode string

	// TaxIDNumber is the tax id number associated with the company
	TaxIDNumber string

	// Role isthe role of the investor in the above company
	Role string
}

type ContractAuction struct {
	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
	ProposedContract []Project

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

	// ProposedContractIndices contains the indices of all proposed projects
	ProposedContractIndices []int

	// PresentContractIndices contains the indices of all present projects
	PresentContractIndices []int

	// 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 Feedback struct {
	// Content is the content of the feedback
	Content string

	// From denotes who gave the feedback
	From Entity

	// To denotes to whom the feedback was targeted towards
	To Entity

	// Date contains the data when the feedback was given
	Date string

	// Contract is the project for which the feedback was given for.
	Contract []Project
}

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

	// C is a structure containing all details of the company the investor is part of
	C Company

	// Company denotes whether the given investor is acting on behalf of a company
	Company bool

	// 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
}

type Project struct {
	// Index is the project index
	Index int

	// TotalValue is the value of value of the advertised project
	TotalValue float64

	// Lock locks investments in order to wait for the recipient's confirmation
	Lock bool

	// LockPwd is the recipient's seedpwd. Will be set to null after used once
	LockPwd string

	// Chain is the blockchain the smart contract is based on
	Chain string

	// OneTimeUnlock is a one time unlock password where the recipient stores their. Set to null after single use
	OneTimeUnlock string

	// AmountOwed is the amount owed to investors.
	AmountOwed float64

	// Reputation is the positive reputation associated with a project
	Reputation float64

	// Votes is the number of votes towards a proposed contract by investors
	Votes float64

	// OwnershipShift is the percentage of the project that the recipient owns
	OwnershipShift float64

	// StageData is the data associated with stage migrations
	StageData []string

	// StageChecklist is the checklist that has to be completed before moving on to the next stage
	StageChecklist []map[string]bool

	// InvestorMap publicKey: %investment map
	InvestorMap map[string]float64

	// SeedInvestorMap publicKey: %investment map for seed invstors
	SeedInvestorMap map[string]float64

	// WaterfallMap publickey:amount map used to pay project stakeholders
	WaterfallMap map[string]float64

	// RecipientIndex is the index of the project's main recipient
	RecipientIndex int

	// OriginatorIndex is the originator's index
	OriginatorIndex int

	// GuarantorIndex is the person guaranteeing the project
	GuarantorIndex int

	// ContractorIndex is the person who proposed the contract
	ContractorIndex int

	// InvestorIndices contains the various investors who have invested
	InvestorIndices []int

	// SeedInvestorIndices contains investors who took part before the contract was at stage 3
	SeedInvestorIndices []int

	// DateInitiated contains the date when the project was created
	DateInitiated string

	// DateFunded contains the date that the project completed the stage 4-5 migration
	DateFunded string

	// DateLastPaid contains the int64 ie unix time of last payment
	DateLastPaid int64

	// AuctionType is the type of the auction the recipient has chosen (if they have)
	AuctionType string

	// InvestmentType is the type of investment - equity crowdfunding, municipal bond, normal crowdfunding, etc
	InvestmentType string

	// PaybackPeriod is the frequency in number of weeks that the recipient has to pay back the platform
	PaybackPeriod time.Duration

	// Stage is the stage at which the contract is at
	Stage int

	// InvestorAssetCode the code of the asset given to investors on investment in the project
	InvestorAssetCode string

	// DebtAssetCode is the code of the asset given to recipients on receiving a project
	DebtAssetCode string

	// PaybackAssetCode is the code of the asset given to recipients on receiving a project
	PaybackAssetCode string

	// SeedAssetCode is the code of the asset given to seed investors on seed investment in the project
	SeedAssetCode string

	// SeedInvestmentFactor is the factor that a seed investor's investment is multiplied by in case they do invest at the seed stage
	SeedInvestmentFactor float64

	// SeedInvestmentCap is the max amount that a seed investor can put in a project when it is the seed stage
	SeedInvestmentCap float64

	// EscrowPubkey is the publickey of the escrow we setup after project investment
	EscrowPubkey string

	// EscrowLock is used to lock the escrow in case someting goes wrong
	EscrowLock bool

	// MoneyRaised is total money that has been raised until now
	MoneyRaised float64

	// SeedMoneyRaised is the total seed money that has been raised until now
	SeedMoneyRaised float64

	// EstimatedAcquisition is the year by which the recipient is expected to repay the initial investment amount
	EstimatedAcquisition int

	// BalLeft is the balance left against the original investment
	BalLeft float64

	// AdminFlagged is set if someone reports the project
	AdminFlagged bool

	// FlaggedBy is the index of the admin who flagged the project
	FlaggedBy int

	// UserFlaggedBy contains the indices of users who flagged the project
	UserFlaggedBy []int

	// Reports is the total number of reports against this particular project
	Reports int

	// TellerUrl isthe url of the teller
	TellerUrl string

	// BrokerUrl isthe url of the MQTT broker
	BrokerUrl string

	// TellerPublishTopic is the topic using which the publisher / subscriber must post / subscribe messages from
	TellerPublishTopic string

	// Metadata contains other metadata and is used to derive project asset ids.
	Metadata string

	// InterestRate is the rate of return for investors
	InterestRate float64 `json:"Interest Rate"`

	// Content contains the bulk of the non smart contract data
	Content CMS

	// below are non critical params only used on the frontend
	Name               string    `json:"Name"`                 // the name of the project / the identifier by which its referred to
	City               string    `json:"City"`                 // the city in which the project is located at
	State              string    `json:"State"`                // the state in which the project has been installed in
	Country            string    `json:"Country"`              // the country in which the project has been installed in
	SelfFund           float64   `json:"Amount Self Funded"`   // the amount that a beneficiary / recipient puts in a project without 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
	MainDeveloperIndex int       `json:"Main Developer Index"` // the main developer of the project
	DeveloperIndices   []int     `json:"Developer Indices"`    // the indices of the developers involved in the project`
	ContractorFee      float64   `json:"Contractor Fee"`       // fee paid to the contractor from the total fee of the project
	OriginatorFee      float64   `json:"Originator Fee"`       // fee paid to the originator included in the total value of the project
	DeveloperFee       []float64 `json:"Developer Fee"`        // the fees charged by the developers
	MainImage          string    `json:"MainImage"`            // The main image of the project
	SmallImage         string    `json:"SmallImage"`           // The small image to be used on the explore tab
}

type Recipient struct {

	// U imports the base User class from openx
	U *openx.User

	// C is a structure containing all details of the company the investor is part of
	C Company

	// Company denotes whether the given investor is acting on behalf of a company
	Company bool

	// ReceivedSolarProjects stores the projects that the recipient is receiver of
	ReceivedSolarProjects []string

	// ReceivedSolarProjectIndices stores the indices of the projects the recipient is part of
	ReceivedSolarProjectIndices []int

	// DeviceId is the device ID of the associated solar hub / IoT device
	DeviceId string

	// DeviceStarts contains the start time of the above IoT devices.
	DeviceStarts []string

	// DeviceLocation stores the physical location of the device powered by Google APIs.
	DeviceLocation string

	// StateHashes stores the list of state updates (ipfs hashes) of the teller
	StateHashes []string

	// TellerEnergy contains the net energy consumed during a given period
	TellerEnergy uint32

	// Autoreload is a bool to denote whether the recipient wants to reload balance from their secondary account
	Autoreload bool
}

type Stage struct {
	Number          int
	FriendlyName    string   // the informal name that one can use while referring to the stage
	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
}