Struct massa_models::secure_share::SecureShare

pub struct SecureShare<T, ID>
where
    T: Display + SecureShareContent,
    ID: Id,
{
    pub content: T,
    pub serialized_data: Vec<u8>,
    pub signature: Signature,
    pub content_creator_pub_key: PublicKey,
    pub content_creator_address: Address,
    pub id: ID,
}

Packages type T such that it can be securely sent and received in a trust-free network

If the internal content is mutated, then it must be re-wrapped, as the associated signature, serialized data, etc. would no longer be in sync

Fields

content: T

Reference contents. Not required for the security protocols.

Use the Lightweight equivalent structures when you need verifiable serialized data, but do not need to read the values directly (such as when sending)

serialized_data: Vec<u8>

Content in sharable, deserializable form. Is used in the secure verification protocols.

signature: Signature

A cryptographically generated value using serialized_data and a public key.

content_creator_pub_key: PublicKey

The public-key component used in the generation of the signature

content_creator_address: Address

Derived from the same public key used to generate the signature

id: ID

A secure hash of the data. See also massa_hash::Hash

Implementations

impl SecureShare<Block, BlockId>

pub fn bytes_count(&self) -> u64

size in bytes of the whole block

pub fn contains_operation(&self, op: SecureShareOperation) -> bool

true if given operation is included in the block

pub fn get_fitness(&self) -> u64

returns the fitness of the block

impl SecureShare<BlockHeader, BlockId>

pub fn get_fitness(&self) -> u64

gets the header fitness

impl SecureShare<Operation, OperationId>

pub fn get_validity_range( &self, operation_validity_period: u64, ) -> RangeInclusive<u64>

get the range of periods during which an operation is valid Range: (op.expire_period - cfg.operation_validity_period) -> op.expire_period (included)

pub fn get_gas_usage( &self, base_operation_gas_cost: u64, sp_compilation_cost: u64, ) -> u64

Get the maximum amount of gas used by the operation.

base_operation_gas_cost comes from the configuration and is the cost of a basic operation (BASE_OPERATION_GAS_COST)

pub fn get_ledger_involved_addresses(&self) -> PreHashSet<Address>

get the addresses that are involved in this operation from a ledger point of view

pub fn get_max_spending(&self, roll_price: Amount) -> Amount

Gets the maximal amount of coins that may be spent by this operation (incl. fee)

pub fn get_roll_involved_addresses( &self, ) -> Result<PreHashSet<Address>, ModelsError>

get the addresses that are involved in this operation from a rolls point of view

impl<T, ID> SecureShare<T, ID>

where T: Display + SecureShareContent, ID: Id,

pub fn sign( keypair: &KeyPair, content_hash: &Hash, _content: &T, ) -> Result<Signature, ModelsError>

Sign the SecureShare given the content

pub fn verify_signature(&self) -> Result<(), ModelsError>

check if self has been signed by public key

pub fn compute_signed_hash(&self) -> Hash

Compute the signed hash

pub fn serialized_size(&self) -> usize

get full serialized size

Trait Implementations

impl<T, ID> Clone for SecureShare<T, ID>

where T: Display + SecureShareContent + Clone, ID: Id + Clone,

fn clone(&self) -> SecureShare<T, ID>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, ID> Debug for SecureShare<T, ID>

where T: Display + SecureShareContent + Debug, ID: Id + Debug,

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

Formats the value using the given formatter.

impl<'de, T, ID> Deserialize<'de> for SecureShare<T, ID>

where T: Display + SecureShareContent + Deserialize<'de>, ID: Id + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, ID, Deser> Deserializer<SecureShare<T, ID>> for SecureShareDeserializer<T, Deser>

where T: Display + SecureShareContent, ID: Id, Deser: Deserializer<T>,

fn deserialize<'a, E: ParseError<&'a [u8]> + ContextError<&'a [u8]>>( &self, buffer: &'a [u8], ) -> IResult<&'a [u8], SecureShare<T, ID>, E>

use massa_models::block_id::BlockId;
use massa_models::config::CHAINID;

let content = Endorsement {
   slot: Slot::new(10, 1),
   index: 0,
   endorsed_block: BlockId::generate_from_hash(Hash::compute_from("blk".as_bytes())),
};
let keypair = KeyPair::generate(0).unwrap();
let secured: SecureShare<Endorsement, BlockId> = Endorsement::new_verifiable(
   content,
   EndorsementSerializer::new(),
   &keypair,
   *CHAINID
).unwrap();
let mut serialized_data = Vec::new();
let serialized = SecureShareSerializer::new().serialize(&secured, &mut serialized_data).unwrap();
let deserializer = SecureShareDeserializer::new(EndorsementDeserializer::new(32, 1), 77);
let (rest, deserialized): (&[u8], SecureShare<Endorsement, BlockId>) = deserializer.deserialize::<DeserializeError>(&serialized_data).unwrap();
assert!(rest.is_empty());
assert_eq!(secured.id, deserialized.id);

impl<T, ID> Display for SecureShare<T, ID>

where T: Display + SecureShareContent, ID: Id,

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

Formats the value using the given formatter.

impl From<&SecureShare<BlockHeader, BlockId>> for DenunciationPrecursor

fn from(value: &SecuredHeader) -> Self

Converts to this type from the input type.

impl From<&SecureShare<Endorsement, EndorsementId>> for DenunciationPrecursor

fn from(value: &SecureShareEndorsement) -> Self

Converts to this type from the input type.

impl From<SecureShare<Block, BlockId>> for SignedBlock

fn from(value: SecureShareBlock) -> Self

Converts to this type from the input type.

impl From<SecureShare<BlockHeader, BlockId>> for SignedBlockHeader

fn from(value: SecuredHeader) -> Self

Converts to this type from the input type.

impl From<SecureShare<Endorsement, EndorsementId>> for SignedEndorsement

fn from(value: SecureShareEndorsement) -> Self

Converts to this type from the input type.

impl From<SecureShare<Operation, OperationId>> for SignedOperation

fn from(value: SecureShareOperation) -> Self

Converts to this type from the input type.

impl<T, ID> PartialEq for SecureShare<T, ID>

where T: Display + SecureShareContent + PartialEq, ID: Id + PartialEq,

fn eq(&self, other: &SecureShare<T, ID>) -> 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<T, ID> Serialize for SecureShare<T, ID>

where T: Display + SecureShareContent + Serialize, ID: Id + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, ID> Serializer<SecureShare<T, ID>> for SecureShareSerializer

where T: Display + SecureShareContent, ID: Id,

fn serialize( &self, value: &SecureShare<T, ID>, buffer: &mut Vec<u8>, ) -> Result<(), SerializeError>

Serialize a value T into a buffer of u8.

impl<T, ID> Eq for SecureShare<T, ID>

where T: Display + SecureShareContent + Eq, ID: Id + Eq,

impl<T, ID> StructuralPartialEq for SecureShare<T, ID>

where T: Display + SecureShareContent, ID: Id,