catalog

Documentation

Index

• Constants
• Variables
• func CryptoProviderManifestDigest() string
• type CryptoImageMetadata
• type CryptoNetworkMetadata
• type CryptoProfile
  • func CryptoNetworkProfile(chain string) (CryptoProfile, bool)
  • func (p CryptoProfile) NetworkProduct(orgID string) NetworkProduct
  • func (p CryptoProfile) ProviderContract() ProviderContract
• type CryptoProofMetadata
• type CryptoProviderManifestDocument
  • func CryptoProviderManifest() CryptoProviderManifestDocument
  • func (m CryptoProviderManifestDocument) Validate() error
• type CryptoRewardMetadata
• type CryptoRewardRoutingPolicy
• type CryptoRoleMetadata
• type CryptoRoleProfile
  • func CryptoRoleProfileByID(roleID string) (CryptoRoleProfile, bool)
  • func CryptoRoleProfiles() []CryptoRoleProfile
• type CryptoStorageMetadata
• type ExecutionSecurityTier
• type NetworkMode
• type NetworkOperatingMode
• type NetworkProduct
• type PlacementConstraints
• type PlacementRequirements
• type ProofTier
• type ProviderConfig
• type ProviderContract
• type ProviderRuntimeContract
• type ProviderRuntimeProfile
• type ProviderUpstreamClientRequirement
  • func CryptoUpstreamClientRequirement(chain string) (ProviderUpstreamClientRequirement, bool)
• type ProviderUpstreamImagePolicy
• type SessionPolicy
• type SettlementTarget
• type StorageGuidance

Constants

const (
	CryptoStorageArchiveFull            = "archive-full"
	CryptoNetworkProfilePublicChainPeer = "public-chain-peer"
	CryptoRewardDestinationTreasury     = "treasury"
	CryptoProofModeOperationalEvidence  = "operational-evidence"
	CryptoProofModeMiningShare          = "mining-share"
	CryptoProofModeValidatorDuty        = "validator-duty"
	CryptoProofModeProtocolReward       = "protocol-reward"
	CryptoRoleFullNode                  = "full-node"
	CryptoRoleMiner                     = "miner"
	CryptoRoleValidator                 = "validator"
	CryptoRoleProtocolReward            = "protocol-reward"
	CryptoRoleStatusSupported           = "supported"
	CryptoRoleStatusDeferred            = "deferred"
)

const (
	Version = core.Version

	NetworkModeNodeService = core.NetworkModeNodeService

	ExecutionSandboxedContainer = core.ExecutionSandboxedContainer
	ProofArtifactHash           = core.ProofArtifactHash

	NetworkModeDirect = core.NetworkModeDirect
	NetworkModeRelay  = core.NetworkModeRelay

	UpstreamClientConformanceShapeOnly  = core.UpstreamClientConformanceShapeOnly
	UpstreamClientConformanceRealClient = core.UpstreamClientConformanceRealClient

	SettlementTargetTreasuryWallet = core.SettlementTargetTreasuryWallet

	CryptoRewardCustodyTreasuryThenDistribute = core.CryptoRewardCustodyTreasuryThenDistribute
	CryptoRewardDistributionContributionShare = core.CryptoRewardDistributionContributionShare
	CryptoRewardParticipantAccountWallet      = core.CryptoRewardParticipantAccountWallet
)

Variables

var (
	CanonicalHash                 = core.CanonicalHash
	DefaultProviderRuntimeProfile = core.DefaultProviderRuntimeProfile
)

Functions

func CryptoProviderManifestDigest

func CryptoProviderManifestDigest() string

Types

type CryptoImageMetadata

type CryptoImageMetadata struct {
	UpstreamClientName       string   `json:"upstream_client_name"`
	DigestPinnedRequired     bool     `json:"digest_pinned_required"`
	OperatorSuppliedRequired bool     `json:"operator_supplied_required,omitempty"`
	RecommendedImageRef      string   `json:"recommended_image_ref,omitempty"`
	KnownImageRefs           []string `json:"known_image_refs,omitempty"`
}

type CryptoNetworkMetadata

type CryptoNetworkMetadata struct {
	ProfileID                 string `json:"profile_id"`
	PeerPort                  int    `json:"peer_port"`
	AllowedPeerPorts          []int  `json:"allowed_peer_ports,omitempty"`
	RequiresIngress           bool   `json:"requires_ingress"`
	UsesDNSSeeds              bool   `json:"uses_dns_seeds"`
	RPCPrivateOnly            bool   `json:"rpc_private_only"`
	AuditRequired             bool   `json:"audit_required"`
	MaxOutboundPeers          int    `json:"max_outbound_peers"`
	MaxOutboundBytesPerSecond int64  `json:"max_outbound_bytes_per_second"`
	KillClosesPeers           bool   `json:"kill_closes_peers"`
}

type CryptoProfile

type CryptoProfile struct {
	Chain             string                `json:"chain"`
	ProductID         string                `json:"product_id"`
	DisplayName       string                `json:"display_name"`
	Purpose           string                `json:"purpose"`
	PoolID            string                `json:"pool_id"`
	ProviderID        string                `json:"provider_id"`
	ContractID        string                `json:"contract_id"`
	SchemaRef         string                `json:"schema_ref"`
	SchemaDigest      string                `json:"schema_digest"`
	ConfigRef         string                `json:"config_ref"`
	SettlementNetwork string                `json:"settlement_network"`
	WalletRef         string                `json:"wallet_ref"`
	MinDiskBytes      int64                 `json:"min_disk_bytes"`
	MinMemoryBytes    int64                 `json:"min_memory_bytes"`
	MinBandwidthMbps  int64                 `json:"min_bandwidth_mbps"`
	Role              CryptoRoleMetadata    `json:"role"`
	Storage           CryptoStorageMetadata `json:"storage"`
	Network           CryptoNetworkMetadata `json:"network"`
	Rewards           CryptoRewardMetadata  `json:"rewards"`
	Proof             CryptoProofMetadata   `json:"proof"`
	Image             CryptoImageMetadata   `json:"image"`
}

func CryptoNetworkProfile

func CryptoNetworkProfile(chain string) (CryptoProfile, bool)

func (CryptoProfile) NetworkProduct

func (p CryptoProfile) NetworkProduct(orgID string) NetworkProduct

func (CryptoProfile) ProviderContract

func (p CryptoProfile) ProviderContract() ProviderContract

type CryptoProofMetadata

type CryptoProofMetadata struct {
	Mode                      string   `json:"mode"`
	ShapeOnly                 bool     `json:"shape_only"`
	ProtocolNativeRewardProof bool     `json:"protocol_native_reward_proof"`
	EvidenceRefs              []string `json:"evidence_refs,omitempty"`
}

type CryptoProviderManifestDocument

type CryptoProviderManifestDocument struct {
	ProtocolVersion string              `json:"protocol_version"`
	PluginID        string              `json:"plugin_id"`
	Version         string              `json:"version"`
	RoleProfiles    []CryptoRoleProfile `json:"role_profiles"`
	Profiles        []CryptoProfile     `json:"profiles"`
}

func CryptoProviderManifest

func CryptoProviderManifest() CryptoProviderManifestDocument

func (CryptoProviderManifestDocument) Validate

func (m CryptoProviderManifestDocument) Validate() error

type CryptoRewardMetadata

type CryptoRewardMetadata struct {
	ProtocolRewardDestination  string `json:"protocol_reward_destination"`
	TreasuryAccountID          string `json:"treasury_account_id,omitempty"`
	TreasuryWalletRef          string `json:"treasury_wallet_ref,omitempty"`
	ManagementFeeBasisPoints   int    `json:"management_fee_basis_points"`
	DirectWorkerPayout         bool   `json:"direct_worker_payout"`
	ProtocolRewardProofClaimed bool   `json:"protocol_reward_proof_claimed"`
}

type CryptoRewardRoutingPolicy

type CryptoRewardRoutingPolicy = core.CryptoRewardRoutingPolicy

type CryptoRoleMetadata

type CryptoRoleMetadata struct {
	ID                       string `json:"id"`
	ShapeOnly                bool   `json:"shape_only"`
	ProtocolRewardsAssumed   bool   `json:"protocol_rewards_assumed"`
	OperationalConformanceID string `json:"operational_conformance_id,omitempty"`
}

type CryptoRoleProfile

type CryptoRoleProfile struct {
	ID                           string   `json:"id"`
	Status                       string   `json:"status"`
	DisplayName                  string   `json:"display_name"`
	Description                  string   `json:"description"`
	ProofMode                    string   `json:"proof_mode"`
	TreasuryRequired             bool     `json:"treasury_required"`
	DirectWorkerPayout           bool     `json:"direct_worker_payout"`
	ProductCreationSupported     bool     `json:"product_creation_supported"`
	RequiresCustodyContract      bool     `json:"requires_custody_contract,omitempty"`
	RequiresSlashingRiskContract bool     `json:"requires_slashing_risk_contract,omitempty"`
	RequiredEvidence             []string `json:"required_evidence,omitempty"`
	DeferredReason               string   `json:"deferred_reason,omitempty"`
}

func CryptoRoleProfileByID

func CryptoRoleProfileByID(roleID string) (CryptoRoleProfile, bool)

func CryptoRoleProfiles

func CryptoRoleProfiles() []CryptoRoleProfile

type CryptoStorageMetadata

type CryptoStorageMetadata struct {
	Mode                         string `json:"mode"`
	MinDiskBytes                 int64  `json:"min_disk_bytes"`
	MinDiskDisplay               string `json:"min_disk_display"`
	RecommendedDiskBytes         int64  `json:"recommended_disk_bytes"`
	RecommendedDiskDisplay       string `json:"recommended_disk_display"`
	GrowthMarginBytes            int64  `json:"growth_margin_bytes"`
	GrowthMarginDisplay          string `json:"growth_margin_display"`
	DurableVolumeRequired        bool   `json:"durable_volume_required"`
	PreserveOnUpdate             bool   `json:"preserve_on_update"`
	PreserveOnUninstall          bool   `json:"preserve_on_uninstall"`
	PruningSupported             bool   `json:"pruning_supported"`
	SnapshotVerificationRequired bool   `json:"snapshot_verification_required"`
}

type ExecutionSecurityTier

type ExecutionSecurityTier = core.ExecutionSecurityTier

type NetworkMode

type NetworkMode = core.NetworkMode

type NetworkOperatingMode

type NetworkOperatingMode = core.NetworkOperatingMode

type NetworkProduct

type NetworkProduct = core.NetworkProduct

type PlacementConstraints

type PlacementConstraints = core.PlacementConstraints

type PlacementRequirements

type PlacementRequirements = core.PlacementRequirements

type ProofTier

type ProofTier = core.ProofTier

type ProviderConfig

type ProviderConfig = core.ProviderConfig

type ProviderContract

type ProviderContract = core.ProviderContract

type ProviderRuntimeContract

type ProviderRuntimeContract = core.ProviderRuntimeContract

type ProviderRuntimeProfile

type ProviderRuntimeProfile = core.ProviderRuntimeProfile

type ProviderUpstreamClientRequirement

type ProviderUpstreamClientRequirement = core.ProviderUpstreamClientRequirement

func CryptoUpstreamClientRequirement

func CryptoUpstreamClientRequirement(chain string) (ProviderUpstreamClientRequirement, bool)

type ProviderUpstreamImagePolicy

type ProviderUpstreamImagePolicy = core.ProviderUpstreamImagePolicy

type SessionPolicy

type SessionPolicy = core.SessionPolicy

type SettlementTarget

type SettlementTarget = core.SettlementTarget

type StorageGuidance

type StorageGuidance = core.StorageGuidance