contracts

Documentation

Overview

Package contracts exposes the staged ReDevPlugin machine-contract set as an opt-in dependency. Importing the normal Host packages does not link the raw contract bodies into host binaries.

Index

• Variables
• func Open(id ID) (fs.File, error)
• func Read(id ID) ([]byte, error)
• type ArtifactSnapshot
• type Contract
  • func Artifacts() []Contract
  • func RegistryContract() Contract
  • func (c Contract) Bytes() []byte
  • func (c Contract) ID() ID
  • func (c Contract) Path() string
  • func (c Contract) SHA256() string
  • func (c Contract) Version() string
• type GoModuleCoordinate
• type ID
• type NPMPackageCoordinate
• type PackageSetSnapshot
  • func PackageSet() PackageSetSnapshot
• type RegistrySnapshot
  • func ContractRegistry() RegistrySnapshot
• type RustCrateCoordinate
• type UnknownIDError
  • func (e *UnknownIDError) Error() string
  • func (e *UnknownIDError) Unwrap() error

Variables

var ErrUnknownID = errors.New("contract id is unknown")

Functions

func Open

func Open(id ID) (fs.File, error)

func Read

func Read(id ID) ([]byte, error)

Types

type ArtifactSnapshot

type ArtifactSnapshot struct {
	ID      ID     `json:"id"`
	Path    string `json:"path"`
	Version string `json:"version"`
	SHA256  string `json:"sha256"`
}

type Contract

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

func Artifacts

func Artifacts() []Contract

func RegistryContract

func RegistryContract() Contract

func (Contract) Bytes

func (c Contract) Bytes() []byte

func (Contract) ID

func (c Contract) ID() ID

func (Contract) Path

func (c Contract) Path() string

func (Contract) SHA256

func (c Contract) SHA256() string

func (Contract) Version

func (c Contract) Version() string

type GoModuleCoordinate

type GoModuleCoordinate struct {
	Module  string `json:"module"`
	Version string `json:"version"`
}

type ID

type ID string

const (
	IDCompatibilityManifestSchema      ID = "compatibility-manifest-schema"
	IDContractRegistry                 ID = "contract-registry"
	IDContractRegistrySchema           ID = "contract-registry-schema"
	IDErrorCodesSchema                 ID = "error-codes-schema"
	IDExternalSignerRequestSchema      ID = "external-signer-request-schema"
	IDExternalSignerResponseSchema     ID = "external-signer-response-schema"
	IDHostCapabilityContractSchema     ID = "host-capability-contract-schema"
	IDHostCapabilityPinSchema          ID = "host-capability-pin-schema"
	IDIframeBridgeSchema               ID = "iframe-bridge-schema"
	IDManifestSchema                   ID = "manifest-schema"
	IDNetworkGrantSchema               ID = "network-grant-schema"
	IDOpaqueSurfaceDocumentSchema      ID = "opaque-surface-document-schema"
	IDOpaqueSurfaceTransportSchema     ID = "opaque-surface-transport-schema"
	IDOwnerScopeInventoryRegistry      ID = "owner-scope-inventory-registry"
	IDOwnerScopeInventorySchema        ID = "owner-scope-inventory-schema"
	IDOwnerScopeMigrationSchema        ID = "owner-scope-migration-schema"
	IDOwnerScopeRootRecoverySchema     ID = "owner-scope-root-recovery-schema"
	IDPackageSignatureSchema           ID = "package-signature-schema"
	IDPerformanceContract              ID = "performance-contract"
	IDPerformanceEvidenceSchema        ID = "performance-evidence-schema"
	IDPlatformPackagePublicationSchema ID = "platform-package-publication-schema"
	IDPlatformPackageSetSchema         ID = "platform-package-set-schema"
	IDPluginPlatformOpenAPI            ID = "plugin-platform-openapi"
	IDPresentationIconEvidenceSchema   ID = "presentation-icon-evidence-schema"
	IDPresentationLocaleFixture        ID = "presentation-locale-fixture"
	IDProcessContainmentSchema         ID = "process-containment-schema"
	IDPublisherReleaseRefSchema        ID = "publisher-release-ref-schema"
	IDQuarantineCleanupSchema          ID = "quarantine-cleanup-schema"
	IDReleaseMetadataSchema            ID = "release-metadata-schema"
	IDReleasePublisherConfigSchema     ID = "release-publisher-config-schema"
	IDReleaseRevocationPointerSchema   ID = "release-revocation-pointer-schema"
	IDReleaseRevocationSchema          ID = "release-revocation-schema"
	IDReleaseRootDelegationSchema      ID = "release-root-delegation-schema"
	IDReleaseSourcePolicyPointerSchema ID = "release-source-policy-pointer-schema"
	IDReleaseSourcePolicySchema        ID = "release-source-policy-schema"
	IDResourceScopeSchema              ID = "resource-scope-schema"
	IDRuntimeAdmissionSchema           ID = "runtime-admission-schema"
	IDRuntimeDescriptorSchema          ID = "runtime-descriptor-schema"
	IDRuntimeExecJournalSchema         ID = "runtime-exec-journal-schema"
	IDRustIPCSchema                    ID = "rust-ipc-schema"
	IDSessionScopeSchema               ID = "session-scope-schema"
	IDTargetClassifierFixture          ID = "target-classifier-fixture"
	IDTokenTicketSchema                ID = "token-ticket-schema"
	IDWASMWorkerSchema                 ID = "wasm-worker-schema"
	IDWorkerInvocationSchema           ID = "worker-invocation-schema"
)

type NPMPackageCoordinate

type NPMPackageCoordinate struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

type PackageSetSnapshot

type PackageSetSnapshot struct {
	SchemaVersion           string                 `json:"schema_version"`
	PlatformVersion         string                 `json:"platform_version"`
	GoModule                GoModuleCoordinate     `json:"go_module"`
	NPMPackages             []NPMPackageCoordinate `json:"npm_packages"`
	RustCrates              []RustCrateCoordinate  `json:"rust_crates"`
	ContractRegistryVersion string                 `json:"contract_registry_version"`
	ContractSetSHA256       string                 `json:"contract_set_sha256"`
}

func PackageSet

func PackageSet() PackageSetSnapshot

type RegistrySnapshot

type RegistrySnapshot struct {
	SchemaVersion   string             `json:"schema_version"`
	RegistryVersion string             `json:"registry_version"`
	Artifacts       []ArtifactSnapshot `json:"artifacts"`
}

func ContractRegistry

func ContractRegistry() RegistrySnapshot

type RustCrateCoordinate

type RustCrateCoordinate struct {
	Name    string `json:"name"`
	Version string `json:"version"`
	Role    string `json:"role"`
}

type UnknownIDError

type UnknownIDError struct {
	ID ID
}

func (*UnknownIDError) Error

func (e *UnknownIDError) Error() string

func (*UnknownIDError) Unwrap

func (e *UnknownIDError) Unwrap() error