proposal

Documentation

Index

• Variables
• type AISummary
• type Event
• type Proposal
  • func (p *Proposal) IsActive() bool
• type Relayer
• type State
• type SuccessfulVote
• type Timeline
• type Vote
• type VotePreparation
• type VoteValidation
• type VoteValidationError

Variables

var ActionSourceMap = map[coreproposal.TimelineAction]Event{
	coreproposal.Created:             Created,
	coreproposal.Updated:             Updated,
	coreproposal.VotingStartsSoon:    VotingStartsSoon,
	coreproposal.VotingEndsSoon:      VotingEndsSoon,
	coreproposal.VotingStarted:       VotingStarted,
	coreproposal.VotingQuorumReached: VotingReachedQuorum,
	coreproposal.VotingEnded:         VotingEnded,
}

Types

type AISummary

type AISummary struct {
	SummaryMarkdown string `json:"summary_markdown"`
}

type Event

type Event string

const (
	Created             Event = "proposal.created"
	Updated             Event = "proposal.updated"
	VotingStartsSoon    Event = "proposal.voting.starts_soon"
	VotingEndsSoon      Event = "proposal.voting.ends_soon"
	VotingStarted       Event = "proposal.voting.started"
	VotingReachedQuorum Event = "proposal.voting.quorum_reached"
	VotingEnded         Event = "proposal.voting.ended"
)

type Proposal

type Proposal struct {
	ID               string             `json:"id"`
	Ipfs             *string            `json:"ipfs"`
	Author           common.User        `json:"author"`
	Created          common.Time        `json:"created"`
	Network          common.Network     `json:"network"`
	Symbol           string             `json:"symbol"`
	Type             *string            `json:"type"`
	Strategies       []common.Strategy  `json:"strategies"`
	Validation       *common.Validation `json:"validation"`
	Title            string             `json:"title"`
	Body             []common.Content   `json:"body"`
	Discussion       string             `json:"discussion"`
	Choices          []string           `json:"choices"`
	VotingStart      common.Time        `json:"voting_start"`
	VotingEnd        common.Time        `json:"voting_end"`
	Quorum           float64            `json:"quorum"`
	Privacy          *string            `json:"privacy"`
	Snapshot         *string            `json:"snapshot"`
	State            *State             `json:"state"`
	Link             *string            `json:"link"`
	App              *string            `json:"app"`
	Scores           []float64          `json:"scores"`
	ScoresByStrategy interface{}        `json:"scores_by_strategy"`
	ScoresState      *string            `json:"scores_state"`
	ScoresTotal      *float64           `json:"scores_total"`
	ScoresUpdated    *int               `json:"scores_updated"`
	Votes            int                `json:"votes"`
	Flagged          bool               `json:"flagged"`
	DAO              dao.ShortDAO       `json:"dao"`
	Timeline         []Timeline         `json:"timeline,omitempty"`
	UserVote         *Vote              `json:"user_vote"`
	PublicUserVote   *Vote              `json:"public_user_vote"`
}

func (*Proposal) IsActive

func (p *Proposal) IsActive() bool

type Relayer

type Relayer struct {
	Address string `json:"address"`
	Receipt string `json:"receipt"`
}

type State

type State string

const (
	ClosedState  State = "closed"
	FinalState   State = "final"
	ActiveState  State = "active"
	PendingState State = "pending"
)

type SuccessfulVote

type SuccessfulVote struct {
	ID      string  `json:"id"`
	IPFS    string  `json:"ipfs"`
	Relayer Relayer `json:"relayer"`
}

type Timeline

type Timeline struct {
	CreatedAt common.Time `json:"created_at"`
	Event     Event       `json:"event"`
}

type Vote

type Vote struct {
	ID           string          `json:"id"`
	Ipfs         string          `json:"ipfs"`
	Voter        common.User     `json:"voter"`
	CreatedAt    common.Time     `json:"created_at"`
	DaoID        uuid.UUID       `json:"dao_id"`
	ProposalID   string          `json:"proposal_id"`
	Choice       json.RawMessage `json:"choice"`
	Reason       string          `json:"reason"`
	App          string          `json:"app"`
	Vp           float64         `json:"vp"`
	VpByStrategy []float32       `json:"vp_by_strategy"`
	VpState      string          `json:"vp_state"`
}

type VotePreparation

type VotePreparation struct {
	ID        string `json:"id"`
	TypedData string `json:"typed_data"`
}

type VoteValidation

type VoteValidation struct {
	OK                  bool                 `json:"ok"`
	VotingPower         float64              `json:"voting_power"`
	VoteValidationError *VoteValidationError `json:"error,omitempty"`
}

type VoteValidationError

type VoteValidationError struct {
	Message string `json:"message"`
	Code    uint32 `json:"code"`
}