Spectre.Governance.ChangeSet (Spectre v0.3.0)

Immutable, non-executable proposal to derive a Definition from an observed Instance Activation.

A ChangeSet binds the exact Activation receipt, Candidate, Definition, authority epoch, and mechanical evidence observed by its author. Composition fails when any of those observations is stale; rebasing is always an explicit new ChangeSet.

Summary

Types

t()

Functions

decode(encoded)

Decodes and revalidates a ChangeSet.

digest(change_set)

Returns the stable ChangeSet digest.

encode(change_set)

Encodes a ChangeSet with the production canonical codec.

evidence_digest(activation)

Derives the mechanical evidence digest used for stale-base detection.

evidence_digest(activation, evidence)

Binds an Activation to exact Reflection/Experience evidence.

from_data(data)

Restores a ChangeSet from portable data.

new(change_set)

Builds and verifies a ChangeSet from host or decoded JSON-shaped data.

new!(attrs)

Builds a ChangeSet or raises with the stable validation reason.

operation_limit()

Returns the maximum number of ordered operations in one ChangeSet.

schema_version()

Returns the ChangeSet schema version.

to_data(change_set)

Returns canonical portable ChangeSet data.

verify_base(change_set, activation)

Checks that this proposal still describes the supplied Activation.

verify_base(change_set, activation, evidence)

Checks the Activation plus exact external evidence observed by a proposal.

Types

t()

@type t() :: %Spectre.Governance.ChangeSet{
  author_ref: String.t(),
  base_activation_receipt: String.t(),
  base_candidate_ref: Spectre.Definition.Candidate.Ref.t(),
  created_at: non_neg_integer(),
  observed_authority_epoch: non_neg_integer(),
  observed_definition_ref: Spectre.Definition.Ref.t(),
  observed_evidence_digest: String.t(),
  operations: [Spectre.Governance.ChangeSet.Operation.t()],
  provenance: map(),
  reason: String.t(),
  schema_version: pos_integer()
}

Functions

decode(encoded)

@spec decode(binary()) :: {:ok, t()} | {:error, term()}

Decodes and revalidates a ChangeSet.

digest(change_set)

@spec digest(t()) :: String.t()

Returns the stable ChangeSet digest.

encode(change_set)

@spec encode(t()) :: {:ok, binary()} | {:error, term()}

Encodes a ChangeSet with the production canonical codec.

evidence_digest(activation)

@spec evidence_digest(Spectre.Instance.Activation.t()) :: String.t()

Derives the mechanical evidence digest used for stale-base detection.

evidence_digest(activation, evidence)

@spec evidence_digest(Spectre.Instance.Activation.t(), map()) :: String.t()

Binds an Activation to exact Reflection/Experience evidence.

from_data(data)

@spec from_data(map()) :: {:ok, t()} | {:error, term()}

Restores a ChangeSet from portable data.

new(change_set)

@spec new(t() | map() | keyword()) :: {:ok, t()} | {:error, term()}

Builds and verifies a ChangeSet from host or decoded JSON-shaped data.

new!(attrs)

@spec new!(map() | keyword()) :: t()

Builds a ChangeSet or raises with the stable validation reason.

operation_limit()

@spec operation_limit() :: pos_integer()

Returns the maximum number of ordered operations in one ChangeSet.

schema_version()

@spec schema_version() :: pos_integer()

Returns the ChangeSet schema version.

to_data(change_set)

@spec to_data(t()) :: map()

Returns canonical portable ChangeSet data.

verify_base(change_set, activation)

@spec verify_base(t(), Spectre.Instance.Activation.t() | nil) ::
  :ok | {:error, term()}

Checks that this proposal still describes the supplied Activation.

verify_base(change_set, activation, evidence)

@spec verify_base(t(), Spectre.Instance.Activation.t() | nil, map()) ::
  :ok | {:error, term()}

Checks the Activation plus exact external evidence observed by a proposal.