Struct Envelope

pub struct Envelope<T, S>
where
    T: Message,
{ /* private fields */ }

Implementations

impl Envelope<TransactionEffects, AuthorityQuorumSignInfo<true>>

pub fn verify_authority_signatures( &self, committee: &Committee, ) -> Result<(), IotaError>

pub fn verify( self, committee: &Committee, ) -> Result<VerifiedEnvelope<TransactionEffects, AuthorityQuorumSignInfo<true>>, IotaError>

impl<T, S> Envelope<T, S>

where T: Message,

pub fn new_from_data_and_sig(data: T, sig: S) -> Envelope<T, S>

pub fn data(&self) -> &T

pub fn into_data(self) -> T

pub fn into_sig(self) -> S

pub fn into_data_and_sig(self) -> (T, S)

pub fn into_unsigned(self) -> Envelope<T, EmptySignInfo>

Remove the authority signatures S from this envelope.

pub fn auth_sig(&self) -> &S

pub fn auth_sig_mut_for_testing(&mut self) -> &mut S

pub fn digest(&self) -> &<T as Message>::DigestType

pub fn data_mut_for_testing(&mut self) -> &mut T

impl<T> Envelope<T, EmptySignInfo>

where T: Message,

pub fn new(data: T) -> Envelope<T, EmptySignInfo>

impl<T> Envelope<T, AuthoritySignInfo>

where T: Message + Serialize,

pub fn new( epoch: u64, data: T, secret: &dyn Signer<BLS12381Signature>, authority: AuthorityPublicKeyBytes, ) -> Envelope<T, AuthoritySignInfo>

pub fn sign( epoch: u64, data: &T, secret: &dyn Signer<BLS12381Signature>, authority: AuthorityPublicKeyBytes, ) -> AuthoritySignInfo

pub fn epoch(&self) -> u64

impl Envelope<SenderSignedData, AuthoritySignInfo>

pub fn verify_committee_sigs_only( &self, committee: &Committee, ) -> Result<(), IotaError>

impl<T, const S: bool> Envelope<T, AuthorityQuorumSignInfo<S>>

where T: Message + Serialize,

pub fn new( data: T, signatures: Vec<AuthoritySignInfo>, committee: &Committee, ) -> Result<Envelope<T, AuthorityQuorumSignInfo<S>>, IotaError>

pub fn new_from_keypairs_for_testing( data: T, keypairs: &[BLS12381KeyPair], committee: &Committee, ) -> Envelope<T, AuthorityQuorumSignInfo<S>>

pub fn epoch(&self) -> u64

impl Envelope<CheckpointSummary, AuthorityQuorumSignInfo<true>>

pub fn verify_authority_signatures( &self, committee: &Committee, ) -> Result<(), IotaError>

pub fn try_into_verified( self, committee: &Committee, ) -> Result<VerifiedEnvelope<CheckpointSummary, AuthorityQuorumSignInfo<true>>, IotaError>

pub fn verify_with_contents( &self, committee: &Committee, contents: Option<&CheckpointContents>, ) -> Result<(), IotaError>

pub fn into_summary_and_sequence(self) -> (u64, CheckpointSummary)

pub fn get_validator_signature(self) -> BLS12381AggregateSignature

impl Envelope<CheckpointSummary, AuthoritySignInfo>

pub fn verify_authority_signatures( &self, committee: &Committee, ) -> Result<(), IotaError>

pub fn try_into_verified( self, committee: &Committee, ) -> Result<VerifiedEnvelope<CheckpointSummary, AuthoritySignInfo>, IotaError>

impl<S> Envelope<SenderSignedData, S>

pub fn sender_address(&self) -> IotaAddress

pub fn gas(&self) -> &[(ObjectID, SequenceNumber, ObjectDigest)]

pub fn contains_shared_object(&self) -> bool

pub fn shared_input_objects(&self) -> impl Iterator<Item = SharedInputObject>

pub fn key(&self) -> TransactionKey

pub fn non_digest_key(&self) -> Option<TransactionKey>

pub fn is_system_tx(&self) -> bool

pub fn is_sponsored_tx(&self) -> bool

impl Envelope<SenderSignedData, EmptySignInfo>

pub fn from_data_and_signer( data: TransactionData, signers: Vec<&dyn Signer<Signature>>, ) -> Envelope<SenderSignedData, EmptySignInfo>

pub fn from_data( data: TransactionData, signatures: Vec<Signature>, ) -> Envelope<SenderSignedData, EmptySignInfo>

pub fn signature_from_signer( data: TransactionData, intent: Intent, signer: &dyn Signer<Signature>, ) -> Signature

pub fn from_generic_sig_data( data: TransactionData, signatures: Vec<GenericSignature>, ) -> Envelope<SenderSignedData, EmptySignInfo>

pub fn to_tx_bytes_and_signatures(&self) -> (Base64, Vec<Base64>)

Returns the Base64 encoded tx_bytes and a list of Base64 encoded [enum GenericSignature].

impl Envelope<SenderSignedData, EmptySignInfo>

pub fn verify_signature_for_testing( &self, current_epoch: u64, verify_params: &VerifyParams, ) -> Result<(), IotaError>

pub fn try_into_verified_for_testing( self, current_epoch: u64, verify_params: &VerifyParams, ) -> Result<VerifiedEnvelope<SenderSignedData, EmptySignInfo>, IotaError>

impl Envelope<SenderSignedData, AuthoritySignInfo>

pub fn verify_signatures_authenticated_for_testing( &self, committee: &Committee, verify_params: &VerifyParams, ) -> Result<(), IotaError>

pub fn try_into_verified_for_testing( self, committee: &Committee, verify_params: &VerifyParams, ) -> Result<VerifiedEnvelope<SenderSignedData, AuthoritySignInfo>, IotaError>

impl Envelope<SenderSignedData, AuthorityQuorumSignInfo<true>>

pub fn certificate_digest(&self) -> CertificateDigest

pub fn gas_price(&self) -> u64

pub fn verify_signatures_authenticated( &self, committee: &Committee, verify_params: &VerifyParams, zklogin_inputs_cache: Arc<VerifiedDigestCache<ZKLoginInputsDigest>>, ) -> Result<(), IotaError>

pub fn try_into_verified_for_testing( self, committee: &Committee, verify_params: &VerifyParams, ) -> Result<VerifiedEnvelope<SenderSignedData, AuthorityQuorumSignInfo<true>>, IotaError>

pub fn verify_committee_sigs_only( &self, committee: &Committee, ) -> Result<(), IotaError>

Trait Implementations

impl<T, S> Clone for Envelope<T, S>

where T: Clone + Message, S: Clone, <T as Message>::DigestType: Clone,

fn clone(&self) -> Envelope<T, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, S> Debug for Envelope<T, S>

where T: Debug + Message, S: Debug, <T as Message>::DigestType: Debug,

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

Formats the value using the given formatter.

impl<T, S> Deref for Envelope<T, S>

where T: Message,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Envelope<T, S> as Deref>::Target

Dereferences the value.

impl<T, S> DerefMut for Envelope<T, S>

where T: Message,

fn deref_mut(&mut self) -> &mut <Envelope<T, S> as Deref>::Target

Mutably dereferences the value.

impl<'de, T, S> Deserialize<'de> for Envelope<T, S>

where T: Message + Deserialize<'de>, S: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Envelope<T, S>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Envelope<SenderSignedData, AuthorityQuorumSignInfo<true>>

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

Formats the value using the given formatter.

impl From<SignedCheckpointSummary> for Envelope<CheckpointSummary, AuthorityQuorumSignInfo<true>>

fn from( value: SignedCheckpointSummary, ) -> Envelope<CheckpointSummary, AuthorityQuorumSignInfo<true>>

Converts to this type from the input type.

impl From<SignedTransaction> for Envelope<SenderSignedData, EmptySignInfo>

fn from(value: SignedTransaction) -> Envelope<SenderSignedData, EmptySignInfo>

Converts to this type from the input type.

impl<T, S> From<VerifiedEnvelope<T, S>> for Envelope<T, S>

where T: Message,

fn from(v: VerifiedEnvelope<T, S>) -> Envelope<T, S>

Converts to this type from the input type.

impl<T, S> PartialEq for Envelope<T, S>

where T: Message + PartialEq, S: PartialEq,

fn eq(&self, other: &Envelope<T, S>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T, S> Serialize for Envelope<T, S>

where T: Message + Serialize, S: Serialize,

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<T, S> Eq for Envelope<T, S>

where T: Eq + Message, S: Eq, <T as Message>::DigestType: Eq,