schema

type Base64EncodedBytes []byte

type Block struct {
	MinerAddr address.Address      `json:"miner_addr"`
	WinCount  int64                `json:"win_count"`
	Messages  []Base64EncodedBytes `json:"messages"`
}

type Class string

type Diagnostics struct {
	Format string             `json:"format"`
	Data   Base64EncodedBytes `json:"data"`
}

type GenerationData struct {
	Source  string `json:"source,omitempty"`
	Version string `json:"version,omitempty"`
}

type Message struct {
	Bytes Base64EncodedBytes `json:"bytes"`
	// EpochOffset represents the offset from the facet epoch where this message
	// is applied. If missing, it must default to 0 (apply at the facet epoch).
	// It.must be interpreted by the driver as an abi.ChainEpoch in Lotus, or
	// equivalent type in other implementations.
	EpochOffset *int64 `json:"epoch_offset,omitempty"`
}

type Metadata struct {
	ID      string           `json:"id"`
	Version string           `json:"version,omitempty"`
	Desc    string           `json:"description,omitempty"`
	Comment string           `json:"comment,omitempty"`
	Gen     []GenerationData `json:"gen"`
	Tags    []string         `json:"tags,omitempty"`
}

type Postconditions struct {
	ApplyMessageFailures []int      `json:"apply_message_failures,omitempty"`
	StateTree            *StateTree `json:"state_tree"`
	Receipts             []*Receipt `json:"receipts"`
	ReceiptsRoots        []cid.Cid  `json:"receipts_roots,omitempty"`
}

type Preconditions struct {
	// Variants encodes the variants with which this vector can run. Multiple items
	// indicate that this vector can be executed once per variant.
	Variants []Variant `json:"variants"`

	// StateTree is the starting state tree for this vector.
	StateTree *StateTree `json:"state_tree,omitempty"`

	// BaseFee is an optional base fee to inject into the VM when feeding this
	// message. If absent, it defaults to 100 attoFIL.
	BaseFee *big.Int `json:"basefee,omitempty"`

	// CircSupply is optional. If specified, it is the value that will be
	// injected in the VM when feeding this message. If absent, the default
	// value will be injected (TotalFilecoin, the maximum supply of Filecoin
	// that will ever exist). It is usually odd to set it, and it's only here
	// for specialized vectors.
	CircSupply *big.Int `json:"circ_supply,omitempty"`
}

type Randomness []RandomnessMatch

type RandomnessKind string

type RandomnessMatch struct {
	On     RandomnessRule     `json:"on"`
	Return Base64EncodedBytes `json:"ret"`
}

type RandomnessRule struct {
	Kind                RandomnessKind
	DomainSeparationTag int64
	Epoch               int64
	Entropy             Base64EncodedBytes
}

type Receipt struct {
	// ExitCode must be interpreted by the driver as an exitcode.ExitCode
	// in Lotus, or equivalent type in other implementations.
	ExitCode    int64              `json:"exit_code"`
	ReturnValue Base64EncodedBytes `json:"return"`
	GasUsed     int64              `json:"gas_used"`
}

type Selector map[string]string

type StateTree struct {
	RootCID cid.Cid `json:"root_cid"`
}

type TestVector struct {
	Class    `json:"class"`
	Selector `json:"selector,omitempty"`

	// Hints are arbitrary flags that convey information to the driver.
	// Use hints to express facts like this vector is knowingly incorrect
	// (e.g. when the reference implementation is broken), or that drivers
	// should negate the postconditions (i.e. test that they are NOT the ones
	// expressed in the vector), etc.
	//
	// Refer to the Hint* constants for common hints.
	Hints []string `json:"hints,omitempty"`

	Meta *Metadata `json:"_meta"`

	// CAR binary data to be loaded into the test environment, usually a CAR
	// containing multiple state trees, addressed by root CID from the relevant
	// objects.
	CAR Base64EncodedBytes `json:"car"`

	// Randomness encodes randomness to be replayed during the execution of this
	// test vector. See godocs on the Randomness type for more info.
	Randomness Randomness `json:"randomness,omitempty"`

	Pre *Preconditions `json:"preconditions"`

	ApplyMessages []Message `json:"apply_messages,omitempty"`
	ApplyTipsets  []Tipset  `json:"apply_tipsets,omitempty"`

	Post        *Postconditions `json:"postconditions"`
	Diagnostics *Diagnostics    `json:"diagnostics,omitempty"`
}

type Tipset struct {
	// EpochOffset represents the offset from the facet epoch where this tipset
	// is applied. It must be interpreted by the driver as an abi.ChainEpoch
	// in Lotus, or equivalent type in other implementations.
	EpochOffset int64 `json:"epoch_offset"`

	// BaseFee must be interpreted by the driver as an abi.TokenAmount in Lotus,
	// or equivalent type in other implementations.
	BaseFee big.Int `json:"basefee"`

	Blocks []Block `json:"blocks,omitempty"`
}

type Variant struct {
	// ID of the variant, usually the codename of the upgrade.
	ID string `json:"id"`

	// Epoch must be interpreted by the driver as an abi.ChainEpoch in Lotus, or
	// equivalent type in other implementations.
	Epoch int64 `json:"epoch"`

	// NetworkVersion is the network version to feed to the VM for this vector.
	NetworkVersion uint `json:"nv"`
}