Struct sui_types::message_envelope::Envelope

impl Envelope<TransactionEffects, AuthorityQuorumSignInfo<true>>

pub fn verify_authority_signatures(&self, committee: &Committee) -> SuiResult

pub fn verify( self, committee: &Committee ) -> SuiResult<VerifiedCertifiedTransactionEffects>

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::DigestType

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

impl<T: Message> Envelope<T, EmptySignInfo>

pub fn new(data: T) -> Self

impl<T> Envelope<T, AuthoritySignInfo>
where T: Message + Serialize,

pub fn new( epoch: EpochId, data: T, secret: &dyn Signer<AuthoritySignature>, authority: AuthorityName ) -> Self

pub fn sign( epoch: EpochId, data: &T, secret: &dyn Signer<AuthoritySignature>, authority: AuthorityName ) -> AuthoritySignInfo

pub fn epoch(&self) -> EpochId

impl Envelope<SenderSignedData, AuthoritySignInfo>

pub fn verify_committee_sigs_only(&self, committee: &Committee) -> SuiResult

impl<T, const S: bool> Envelope<T, AuthorityQuorumSignInfo<S>>
where T: Message + Serialize,

pub fn new( data: T, signatures: Vec<AuthoritySignInfo>, committee: &Committee ) -> SuiResult<Self>

pub fn new_from_keypairs_for_testing( data: T, keypairs: &[AuthorityKeyPair], committee: &Committee ) -> Self

pub fn epoch(&self) -> EpochId

impl Envelope<CheckpointSummary, AuthorityQuorumSignInfo<true>>

pub fn verify_authority_signatures(&self, committee: &Committee) -> SuiResult

pub fn try_into_verified( self, committee: &Committee ) -> SuiResult<VerifiedCheckpoint>

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

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

pub fn get_validator_signature(self) -> AggregateAuthoritySignature

impl Envelope<CheckpointSummary, AuthoritySignInfo>

pub fn verify_authority_signatures(&self, committee: &Committee) -> SuiResult

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

impl<S> Envelope<SenderSignedData, S>

pub fn sender_address(&self) -> SuiAddress

pub fn gas(&self) -> &[ObjectRef]

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

pub fn is_randomness_reader(&self) -> bool

impl Envelope<SenderSignedData, EmptySignInfo>

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

pub fn from_data(data: TransactionData, signatures: Vec<Signature>) -> Self

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> ) -> Self

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( &self, current_epoch: EpochId, verify_params: &VerifyParams ) -> SuiResult

pub fn try_into_verified( self, current_epoch: EpochId, verify_params: &VerifyParams ) -> SuiResult<VerifiedTransaction>

impl Envelope<SenderSignedData, AuthoritySignInfo>

pub fn verify_signatures_authenticated( &self, committee: &Committee, verify_params: &VerifyParams ) -> SuiResult

pub fn try_into_verified( self, committee: &Committee, verify_params: &VerifyParams ) -> SuiResult<VerifiedSignedTransaction>

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 ) -> SuiResult

pub fn try_into_verified( self, committee: &Committee, verify_params: &VerifyParams ) -> SuiResult<VerifiedCertificate>

pub fn verify_committee_sigs_only(&self, committee: &Committee) -> SuiResult

Trait Implementations§

impl<T: Clone + Message, S: Clone> Clone for Envelope<T, S>
where T::DigestType: Clone,

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

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<T: Debug + Message, S: Debug> Debug for Envelope<T, S>
where T::DigestType: Debug,

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

Formats the value using the given formatter. Read more

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

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

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

Converts to this type from the input type.

impl<T: Message + PartialEq, S: PartialEq> PartialEq for Envelope<T, S>

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

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

1.0.0 · source§

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<T, S> Serialize for Envelope<T, S>
where T: Serialize + Message, S: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl<T: Message + VersionedProtocolMessage, S> VersionedProtocolMessage for Envelope<T, S>

fn check_version_supported(&self, protocol_config: &ProtocolConfig) -> SuiResult

Check that the version of the message is the correct one to use at this protocol version.

fn message_version(&self) -> Option<u64>

Return version of message. Some messages depend on their enclosing messages to know the version number, so not every implementor implements this.

impl<T: Eq + Message, S: Eq> Eq for Envelope<T, S>
where T::DigestType: Eq,

Auto Trait Implementations§

impl<T, S> RefUnwindSafe for Envelope<T, S>
where S: RefUnwindSafe, T: RefUnwindSafe, <T as Message>::DigestType: UnwindSafe + RefUnwindSafe,

impl<T, S> Send for Envelope<T, S>
where S: Send, T: Send, <T as Message>::DigestType: Send,

impl<T, S> Sync for Envelope<T, S>
where S: Sync, T: Sync, <T as Message>::DigestType: Sync + Send,

impl<T, S> Unpin for Envelope<T, S>
where S: Unpin, T: Unpin, <T as Message>::DigestType: Unpin,

impl<T, S> UnwindSafe for Envelope<T, S>
where S: UnwindSafe, T: UnwindSafe, <T as Message>::DigestType: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<S> Export for S
where S: Serialize,

fn export(&self, path: &str) -> Result<(), ConfigError>

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<D> Import for D
where D: DeserializeOwned,

fn import(path: &str) -> Result<Self, ConfigError>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a Request

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> Formattable for T
where T: Deref, <T as Deref>::Target: Formattable,