Struct hdk::prelude::dependencies::holochain_integrity_types::PreflightRequest

pub struct PreflightRequest {
    pub app_entry_hash: HoloHash<Entry>,
    pub signing_agents: Vec<(HoloHash<Agent>, Vec<Role, Global>), Global>,
    pub optional_signing_agents: Vec<(HoloHash<Agent>, Vec<Role, Global>), Global>,
    pub minimum_optional_signing_agents: u8,
    pub enzymatic: bool,
    pub session_times: CounterSigningSessionTimes,
    pub action_base: ActionBase,
    pub preflight_bytes: PreflightBytes,
}

The same PreflightRequest is sent to every agent. Each agent signs this data as part of their PreflightResponse. Every preflight must be identical and signed by every agent for a session to be valid.

Fields

app_entry_hash: HoloHash<Entry>

The hash of the app entry, as if it were not countersigned. The final entry hash will include the countersigning session.

signing_agents: Vec<(HoloHash<Agent>, Vec<Role, Global>), Global>

The agents that are participating in this countersignature session.

optional_signing_agents: Vec<(HoloHash<Agent>, Vec<Role, Global>), Global>

The optional additional M of N signers. If there are additional signers then M MUST be the majority of N. If there are additional signers then the enzyme MUST be used and is the first signer in BOTH signing_agents and optional_signing_agents.

minimum_optional_signing_agents: u8

The M in the M of N signers. M MUST be strictly greater than than N / 2 and NOT larger than N.

enzymatic: bool

The first signing agent (index 0) is acting as an enzyme. If true AND optional_signing_agents are set then the first agent MUST be the same in both signing_agents and optional_signing_agents.

session_times: CounterSigningSessionTimes

The session times. Session actions must all have the same timestamp, which is the session offset.

action_base: ActionBase

The action information that is shared by all agents. Contents depend on the action type, create, update, etc.

preflight_bytes: PreflightBytes

The preflight bytes for session.

Implementations

impl PreflightRequest

pub fn try_new(
    app_entry_hash: HoloHash<Entry>,
    signing_agents: Vec<(HoloHash<Agent>, Vec<Role, Global>), Global>,
    optional_signing_agents: Vec<(HoloHash<Agent>, Vec<Role, Global>), Global>,
    minimum_optional_signing_agents: u8,
    enzymatic: bool,
    session_times: CounterSigningSessionTimes,
    action_base: ActionBase,
    preflight_bytes: PreflightBytes
) -> Result<PreflightRequest, CounterSigningError>

Fallible constructor.

pub fn check_integrity(&self) -> Result<(), CounterSigningError>

Combined integrity checks.

pub fn check_agents_dupes(&self) -> Result<(), CounterSigningError>

Verify there are no duplicate agents to sign.

pub fn check_agents_len(&self) -> Result<(), CounterSigningError>

Verify the number of signing agents is within the correct range.

pub fn check_agents_optional(&self) -> Result<(), CounterSigningError>

Verify the optional signing agents.

pub fn check_agents(&self) -> Result<(), CounterSigningError>

Verify the preflight request agents.

pub fn check_enzyme(&self) -> Result<(), CounterSigningError>

Verify everything about the enzyme.

Trait Implementations

impl Clone for PreflightRequest

fn clone(&self) -> PreflightRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PreflightRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PreflightRequest

fn deserialize<__D>(
    __deserializer: __D
) -> Result<PreflightRequest, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<PreflightRequest> for PreflightRequest

fn eq(&self, other: &PreflightRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PreflightRequest

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PreflightRequest

impl StructuralEq for PreflightRequest

impl StructuralPartialEq for PreflightRequest