company

type CapTable interface {
	SetIncorporation(ctx context.Context, org, companyName, incType, country, state string) error
	SeedFounders(ctx context.Context, org, companyName string, founders []Founder) error
	AddStakeholders(ctx context.Context, org string, holders []Stakeholder) (inserted int, err error)
	RecordRound(ctx context.Context, org string, r RoundInput) (roundID string, err error)
}

type Charger interface {
	Charge(ctx context.Context, org string, amountCents int64, memo string) (ref string, err error)
}

type DocumentSink interface {
	Ingest(ctx context.Context, org, name, contentType string, data []byte) (docID string, err error)
}

type DriveFile struct {
	ID       string `json:"id"`
	Name     string `json:"name"`
	MimeType string `json:"mimeType"`
}

type EquityAnchor interface {
	Anchor(ctx context.Context, f *Formation) (*Genesis, error)
	Configured() bool
}

type Esign interface {
	Request(ctx context.Context, org string, docIDs []string, signers []Signer) (ref string, err error)
	Status(ctx context.Context, org, ref string) (complete bool, err error)
	Name() string
}

type Filing struct {
	// Provider is the filing partner that performed the filing, or "manual" when no
	// partner is wired.
	Provider string `json:"provider"`
	// Ref is the partner's or the state's filing reference. Empty when nothing was
	// actually filed — no filing id is ever fabricated.
	Ref string `json:"ref,omitempty"`
	// Status is manual (no partner wired — a registered agent files out-of-band),
	// submitted (the partner accepted it, awaiting the state), filed (the state
	// accepted it) or rejected.
	Status string `json:"status"`
	// Note explains a filing Hanzo did not perform itself: what remains to be done
	// and by whom.
	Note string `json:"note,omitempty"`
	// At is the unix second the filing record was written.
	At int64 `json:"at,omitempty"`
}

type FilingProvider interface {
	Submit(ctx context.Context, f *Formation) (*Filing, error)
	Status(ctx context.Context, ref string) (*Filing, error)
	Name() string
}

type Filter struct {
	Stage     Stage     // "" = any
	Structure Structure // "" = any
	Limit     int       // <=0 = defaultRegisterLimit
	Offset    int
}

type Formation struct {
	// Org is the owning org — the tenant key, and the reason there is exactly one
	// formation per org.
	Org string `json:"org"`
	// Structure is the legal entity being formed: c-corp, llc or dao-llc.
	Structure Structure `json:"structure"`
	// Jurisdiction is the state of formation: DE or WY.
	Jurisdiction Jurisdiction `json:"jurisdiction"`
	// Name is the company name the entity is being formed under.
	Name string `json:"name"`
	// Stage is the machine's current state: structure, founders, payment, documents,
	// esign or genesis on the formation path, import on the skip path, and company
	// at the terminal.
	Stage Stage `json:"stage"`
	// Founders is every founding stakeholder, with its equity split and KYC state.
	Founders []Founder `json:"founders"`

	// Paid reports whether the one-time formation fee has been charged.
	Paid bool `json:"paid"`
	// PaymentRef is the billing reference recorded for the charged formation fee on
	// the org's own ledger.
	PaymentRef string `json:"paymentRef,omitempty"`

	// DocumentIDs are the data room ids of the GENERATED formation documents.
	DocumentIDs []string `json:"documentIds,omitempty"`
	// Filing is the state-of-incorporation filing record, once documents exist.
	Filing *Filing `json:"filing,omitempty"`

	// Signed reports whether the formation documents have come back signed — the
	// e-signature provider's answer, which a real provider's webhook drives.
	Signed bool `json:"signed"`
	// EsignRef is the e-signature provider's reference for the signature request.
	EsignRef string `json:"esignRef,omitempty"`

	// Genesis is the cap-table equity genesis, once recorded.
	Genesis *Genesis `json:"genesis,omitempty"`

	// AlreadyIncorporated declares an org that already has a legal entity, which
	// takes the import path (structure → import → company) instead of forming one.
	AlreadyIncorporated bool `json:"alreadyIncorporated"`
	// Imported reports whether the existing company's corporate documents have been
	// ingested into the org's data room.
	Imported bool `json:"imported"`
	// ImportedDocs are the data room ids of the documents ingested from Drive.
	ImportedDocs []string `json:"importedDocs,omitempty"`
	// CapTableImported reports whether the existing company's cap table has been
	// imported onto the canonical cap table.
	CapTableImported bool `json:"capTableImported"`

	// CreatedAt is the unix second the formation was opened.
	CreatedAt int64 `json:"createdAt"`
	// UpdatedAt is the unix second of the most recent write to the formation.
	UpdatedAt int64 `json:"updatedAt"`
}

type Founder struct {
	// Name is the founder's full legal name, as it appears on the formation documents.
	Name string `json:"name"`
	// Email is the founder's email, and the key a KYC decision addresses a founder
	// by — POST /v1/company/kyc/decision matches on it.
	Email string `json:"email"`
	// EquityBps is the founder's ownership in basis points, 0–10000 (1% == 100 bps,
	// so 10000 is the whole company). The founders' shares seed the cap-table genesis.
	EquityBps int `json:"equityBps"`
	// KYCStatus is the founder's identity-verification state: pending, verified (a
	// real idv provider reported a pass), reviewer_confirmed (a privileged reviewer
	// confirmed out-of-band) or failed. The payment stage is unreachable until every
	// founder passes.
	KYCStatus string `json:"kycStatus"`
	// KYCRef is the idv provider's session reference for this founder.
	KYCRef string `json:"kycRef,omitempty"`
	// DecidedBy is who settled a terminal KYC status: the provider name, or a
	// reviewer's user id.
	DecidedBy string `json:"decidedBy,omitempty"`
}

type Genesis struct {
	// Root is the 0x-prefixed keccak256 root of the founding allocation. It is
	// ALWAYS computed, whether or not the on-chain anchor is wired, because the root
	// is the tamper-evident witness.
	Root string `json:"root"`
	// TxHash is the L1 transaction hash of the anchoring commit. Empty until anchored.
	TxHash string `json:"txHash,omitempty"`
	// Block is the L1 block the anchoring transaction landed in. Set only once the
	// receipt has been read; absent otherwise.
	Block uint64 `json:"block,omitempty"`
	// ChainID is the EVM chain the root is committed to — the Hanzo L1 by default.
	ChainID int64 `json:"chainId,omitempty"`
	// At is the unix second the genesis root was computed.
	At int64 `json:"at"`
	// Status is pending (root computed, not yet on-chain) or anchored (committed).
	Status string `json:"status"`
	// Note explains an unanchored genesis honestly — anchor wiring absent, or the
	// submit error — rather than reporting a commit that did not happen.
	Note string `json:"note,omitempty"`
}

type GoogleReader interface {
	ListFolder(ctx context.Context, org, folderID string) ([]DriveFile, error)
	Download(ctx context.Context, org string, f DriveFile) (data []byte, contentType string, err error)
	SheetValues(ctx context.Context, org, spreadsheetID, rangeA1 string) ([][]string, error)
}

type Jurisdiction string

type KYCProvider interface {
	Start(ctx context.Context, org string, f Founder) (ref, verifyURL, status string, err error)
	Check(ctx context.Context, ref string) (status string, err error)
	Name() string
}

type OrgUpgrader interface {
	MarkCompany(ctx context.Context, f *Formation) error
}

type Registration struct {
	// Org is the org whose formation this row projects.
	Org string `json:"org"`
	// Stage is the formation's current state — what the platform reads to see which
	// formations are stalled and where.
	Stage Stage `json:"stage"`
	// Structure is the legal entity being formed: c-corp, llc or dao-llc.
	Structure Structure `json:"structure"`
	// Name is the company name the entity is being formed under.
	Name string `json:"name"`
	// CreatedAt is the unix second the formation was opened.
	CreatedAt int64 `json:"createdAt"`
	// UpdatedAt is the unix second of the most recent write to the formation, and
	// the key the register sorts on (newest activity first).
	UpdatedAt int64 `json:"updatedAt"`
}

type RoundInput struct {
	// Name is the round's name on the cap table, e.g. "Seed". Required.
	Name string `json:"name"`
	// RoundType is PRICED, SAFE or CONVERTIBLE_NOTE. Defaults to PRICED.
	RoundType string `json:"roundType"`
	// TargetAmount is the amount the round is raising, recorded verbatim on the
	// canonical cap table's rounds.create contract.
	TargetAmount float64 `json:"targetAmount"`
	// PreMoneyValuation is the valuation the round prices off, before the new money.
	PreMoneyValuation float64 `json:"preMoneyValuation,omitempty"`
	// PricePerShare is the per-share price of a priced round.
	PricePerShare float64 `json:"pricePerShare,omitempty"`
	// ShareClassID is the cap table's share class the round issues into.
	ShareClassID string `json:"shareClassId,omitempty"`
}

type Signer struct {
	// Name is the recipient's name, as it appears on the signature request.
	Name string `json:"name"`
	// Email is the address the signature request is sent to.
	Email string `json:"email"`
}

type Stage string

type Stakeholder struct {
	Name                string `json:"name"`
	Email               string `json:"email"`
	StakeholderType     string `json:"stakeholderType"`     // INDIVIDUAL | INSTITUTION
	CurrentRelationship string `json:"currentRelationship"` // FOUNDER | INVESTOR | EMPLOYEE …
	InstitutionName     string `json:"institutionName,omitempty"`
}

type Store struct {
	// contains filtered or unexported fields
}

type Structure string