Struct private_currency::transactions::Transfer

pub struct Transfer { /* fields omitted */ }

Transfer from one wallet to another wallet.

See crate docs for explanation about fields and workflow of Transfer transactions.

Methods

impl Transfer

pub fn new(     from: &PublicKey,     to: &PublicKey,     rollback_delay: u32,     history_len: u64,     amount: Commitment,     amount_proof: SimpleRangeProof,     sufficient_balance_proof: SimpleRangeProof,     encrypted_data: EncryptedData,     secret_key: &SecretKey ) -> Transfer

Creates message and signs it.

pub fn new_with_signature(     from: &PublicKey,     to: &PublicKey,     rollback_delay: u32,     history_len: u64,     amount: Commitment,     amount_proof: SimpleRangeProof,     sufficient_balance_proof: SimpleRangeProof,     encrypted_data: EncryptedData,     signature: &Signature ) -> Transfer

Creates message and appends existing signature.

pub fn to_hex(&self) -> String

Returns the hex representation of the binary data. Lower case letters are used (e.g. f9b4ca).

pub fn from(&self) -> &PublicKey

Ed25519 public key of the sender. The transaction must be signed with the corresponding secret key.

pub fn to(&self) -> &PublicKey

Ed25519 public key of the receiver.

pub fn rollback_delay(&self) -> u32

Relative delay (measured in block height) to wait for transfer acceptance from the receiver. The delay is counted from the height of a block containing this Transfer.

If the transaction is not Accepted by the receiver when the delay expires, the transfer is automatically rolled back.

pub fn history_len(&self) -> u64

Length of the wallet history as perceived by the wallet sender.

This value may be lesser than the real wallet history length. What’s important is that history_len must not be less then last_send_index of the sender’s wallet (i.e., the sender must be aware of all her outgoing transfers). If history_len is less, the transfer is considered invalid.

pub fn amount(&self) -> Commitment

Commitment to the transferred amount.

pub fn amount_proof(&self) -> SimpleRangeProof

Proof that amount is positive.

pub fn sufficient_balance_proof(&self) -> SimpleRangeProof

Proof that the sender’s balance is sufficient relative to amount.

pub fn encrypted_data(&self) -> EncryptedData

Encryption of the opening for amount.

Trait Implementations

impl Clone for Transfer

fn clone(&self) -> Transfer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AsRef<RawMessage> for Transfer

fn as_ref(&self) -> &RawMessage

Performs the conversion.

impl PartialEq<Transfer> for Transfer

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

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

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

This method tests for !=.

impl Debug for Transfer

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

Formats the value using the given formatter.

impl ExonumJson for Transfer

fn deserialize_field<B>(     value: &Value,     buffer: &mut B,     from: Offset,     to: Offset ) -> Result<(), Box<dyn Error>> where     B: WriteBufferWrapper,

write deserialized field in buffer on place.

fn serialize_field(&self) -> Result<Value, Box<dyn Error + Send + Sync>>

serialize field as json::Value

impl ExonumJsonDeserialize for Transfer

fn deserialize(value: &Value) -> Result<Self, Box<dyn Error>>

deserialize json value.

impl Serialize for Transfer

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Transfer

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

Deserialize this value from the given Serde deserializer.

impl FromHex for Transfer

type Error = Error

fn from_hex<T: AsRef<[u8]>>(hex: T) -> Result<Self, Self::Error>

Creates an instance of type Self from the given hex string, or fails with a custom error type.

impl<'a> SegmentField<'a> for Transfer

fn item_size() -> Offset

size of item fixed part that this Field collect.

fn count(&self) -> Offset

count of items in collection

fn extend_buffer(&self, buffer: &mut Vec<u8>)

extend buffer with this collection

unsafe fn from_buffer(buffer: &'a [u8], from: Offset, count: Offset) -> Self

create collection from buffer

fn check_data(     buffer: &'a [u8],     from: CheckedOffset,     count: CheckedOffset,     latest_segment: CheckedOffset ) -> Result

check collection data

impl ServiceMessage for Transfer

const SERVICE_ID: u16

ID of the service this message belongs to.

const MESSAGE_ID: u16

ID of the message itself. Should be unique within a service.

impl StorageValue for Transfer

fn into_bytes(self) -> Vec<u8>

Serialize a value into a vector of bytes.

fn from_bytes(value: Cow<[u8]>) -> Self

Deserialize a value from bytes.

impl Transaction for Transfer

fn verify(&self) -> bool

Verifies the internal consistency of the transaction. verify should usually include checking the message signature (via [verify_signature]) and, possibly, other internal constraints. verify has no access to the blockchain state; checks involving the blockchain state must be preformed in execute.

fn execute(&self, fork: &mut Fork) -> Result<(), ExecutionError>

Receives a fork of the current blockchain state and can modify it depending on the contents of the transaction.

impl Message for Transfer

fn from_raw(raw: RawMessage) -> Result<Transfer, Error>

Converts the raw message into the specific one.

fn raw(&self) -> &RawMessage

Returns raw message.

fn verify_signature(&self, pub_key: &PublicKey) -> bool

Verifies the message using given public key.