rofl

type AllowedEndorsement struct {
	// Any specifies that any node can endorse the enclave.
	Any *struct{} `json:"any,omitempty" yaml:"any,omitempty"`
	// ComputeRole specifies that a compute node for the current runtime can endorse the enclave.
	ComputeRole *struct{} `json:"role_compute,omitempty" yaml:"role_compute,omitempty"`
	// ObserverRole specifies that an observer node for the current runtime can endorse the enclave.
	ObserverRole *struct{} `json:"role_observer,omitempty" yaml:"role_observer,omitempty"`
	// Entity specifies that a registered node from a specific entity can endorse the enclave.
	Entity *signature.PublicKey `json:"entity,omitempty" yaml:"entity,omitempty"`
	// Node specifies that a specific node can endorse the enclave.
	Node *signature.PublicKey `json:"node,omitempty" yaml:"node,omitempty"`
	// Provider specifies that any node from a specific provider can endorse the enclave.
	Provider *types.Address `json:"provider,omitempty" yaml:"provider,omitempty"`
	// ProviderInstanceAdmin specifies that any provider instance where the given address is currently
	// the admin can endorse the enclave.
	ProviderInstanceAdmin *types.Address `json:"provider_instance_admin,omitempty" yaml:"provider_instance_admin,omitempty"`

	// And evaluates all of the child endorsement policies and allows in case all accept the
	// endorsement.
	And []*AllowedEndorsement `json:"and,omitempty" yaml:"and,omitempty"`
	// Or evaluates all of the child endorsement policies and allows in case any accept the
	// endorsement.
	Or []*AllowedEndorsement `json:"or,omitempty" yaml:"or,omitempty"`
}

type AppAuthPolicy struct {
	// Quotes is a quote policy.
	Quotes quote.Policy `json:"quotes" yaml:"quotes"`
	// Enclaves is the set of allowed enclave identities.
	Enclaves []sgx.EnclaveIdentity `json:"enclaves" yaml:"enclaves"`
	// Endorsements is the set of allowed endorsements.
	Endorsements []AllowedEndorsement `json:"endorsements" yaml:"endorsements"`
	// Fees is the gas fee payment policy.
	Fees FeePolicy `json:"fees" yaml:"fees"`
	// MaxExpiration is the maximum number of future epochs for which one can register.
	MaxExpiration beacon.EpochTime `json:"max_expiration" yaml:"max_expiration"`
}

type AppConfig struct {
	// ID is the application identifier.
	ID AppID `json:"id"`
	// Policy is the application authentication policy.
	Policy AppAuthPolicy `json:"policy"`
	// Admin is the application administrator address.
	Admin *types.Address `json:"admin"`
	// Stake is the staked amount.
	Stake types.BaseUnits `json:"stake"`

	// Metadata are arbitrary key/value pairs.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Secrets are arbitrary SEK-encrypted key/value pairs.
	Secrets map[string][]byte `json:"secrets,omitempty"`
	// SEK is the secrets encryption (public) key.
	SEK x25519.PublicKey `json:"sek"`
}

type AppCreatedEvent struct {
	ID AppID `json:"id"`
}

type AppID address.Address

type AppInstanceQuery struct {
	// App is the application identifier.
	App AppID `json:"app"`
	// RAK is the Runtime Attestation Key.
	RAK types.PublicKey `json:"rak"`
}

type AppQuery struct {
	// ID is the application identifier.
	ID AppID `json:"id"`
}

type AppRemovedEvent struct {
	ID AppID `json:"id"`
}

type AppUpdatedEvent struct {
	ID AppID `json:"id"`
}

type Create struct {
	// Policy is the application authentication policy.
	Policy AppAuthPolicy `json:"policy"`
	// Scheme is the identifier generation scheme.
	Scheme IdentifierScheme `json:"scheme"`
	// Metadata are arbitrary key/value pairs.
	Metadata map[string]string `json:"metadata,omitempty"`
}

type Event struct {
	AppCreated         *AppCreatedEvent
	AppUpdated         *AppUpdatedEvent
	AppRemoved         *AppRemovedEvent
	InstanceRegistered *InstanceRegisteredEvent
}

type FeePolicy uint8

type IdentifierScheme uint8

type InstanceRegisteredEvent struct {
	AppID AppID           `json:"app_id"`
	RAK   types.PublicKey `json:"rak"`
}

type Parameters struct{}

type Register struct {
	// App is the application identifier of the app the caller is registering for.
	App AppID `json:"app"`
	// EndorsedCapability is the endorsed TEE capability.
	EndorsedCapability node.EndorsedCapabilityTEE `json:"ect"` //nolint: misspell
	// Expiration is the epoch when the ROFL registration expires if not renewed.
	Expiration beacon.EpochTime `json:"expiration"`
	// ExtraKeys are the extra public keys to endorse (e.g. secp256k1 keys).
	//
	// All of these keys need to co-sign the registration transaction to prove ownership.
	ExtraKeys []types.PublicKey `json:"extra_keys"`
	// Metadata are arbitrary key/value pairs.
	Metadata map[string]string `json:"metadata,omitempty"`
}

type Registration struct {
	// App is the application this enclave is registered for.
	App AppID `json:"app"`
	// NodeID is the identifier of the endorsing node.
	NodeID signature.PublicKey `json:"node_id"`
	// EntityID is the optional identifier of the endorsing entity.
	EntityID *signature.PublicKey `json:"entity_id,omitempty"`
	// RAK is the Runtime Attestation Key.
	RAK signature.PublicKey `json:"rak"`
	// REK is the Runtime Encryption Key.
	REK x25519.PublicKey `json:"rek"`
	// Expiration is the epoch when the ROFL registration expires if not renewed.
	Expiration beacon.EpochTime `json:"expiration"`
	// ExtraKeys are the extra public keys to endorse (e.g. secp256k1 keys).
	ExtraKeys []types.PublicKey `json:"extra_keys"`
	// Metadata are arbitrary key/value pairs.
	Metadata map[string]string `json:"metadata,omitempty"`
}

type Remove struct {
	// ID is the application identifier.
	ID AppID `json:"id"`
}

type StakeThresholds struct {
	AppCreate *types.BaseUnits `json:"app_create"`
}

type Update struct {
	// ID is the application identifier.
	ID AppID `json:"id"`
	// Policy is the application authentication policy.
	Policy AppAuthPolicy `json:"policy"`
	// Admin is the application administrator address.
	Admin *types.Address `json:"admin"`

	// Metadata are arbitrary key/value pairs.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Secrets are arbitrary encrypted key/value pairs.
	Secrets map[string][]byte `json:"secrets,omitempty"`
}

type V1 interface {
	client.EventDecoder

	// Create generates a rofl.Create transaction.
	Create(policy AppAuthPolicy) *client.TransactionBuilder

	// Update generates a rofl.Update transaction.
	Update(id AppID, policy AppAuthPolicy, admin *types.Address) *client.TransactionBuilder

	// Remove generates a rofl.Remove transaction.
	Remove(id AppID) *client.TransactionBuilder

	// App queries the given application configuration.
	App(ctx context.Context, round uint64, id AppID) (*AppConfig, error)

	// Apps queries all application configurations.
	Apps(ctx context.Context, round uint64) ([]*AppConfig, error)

	// AppInstance queries a specific registered instance of the given application.
	AppInstance(ctx context.Context, round uint64, id AppID, rak types.PublicKey) (*Registration, error)

	// AppInstances queries the registered instances of the given application.
	AppInstances(ctx context.Context, round uint64, id AppID) ([]*Registration, error)

	// StakeThresholds queries the stake information for managing ROFL.
	StakeThresholds(ctx context.Context, round uint64) (*StakeThresholds, error)

	// Parameters queries the module parameters.
	Parameters(ctx context.Context, round uint64) (*Parameters, error)

	// GetEvents returns all rofl events emitted in a given block.
	GetEvents(ctx context.Context, round uint64) ([]*Event, error)
}