Struct fuel_tx::input::coin::Coin

pub struct Coin<Specification>where
    Specification: CoinSpecification,{
    pub utxo_id: UtxoId,
    pub owner: Address,
    pub amount: Word,
    pub asset_id: AssetId,
    pub tx_pointer: TxPointer,
    pub witness_index: Specification::Witness,
    pub maturity: BlockHeight,
    pub predicate: Specification::Predicate,
    pub predicate_data: Specification::PredicateData,
}

It is a full representation of the coin from the specification: https://github.com/FuelLabs/fuel-specs/blob/master/src/protocol/tx_format/input.md#inputcoin.

The specification defines the layout of the Coin in the serialized form for the fuel-vm. But on the business logic level, we don’t use all fields at the same time. It is why in the super::Input the coin is represented by several forms based on the usage context. Leaving some fields empty reduces the memory consumption by the structure and erases the empty useless fields.

The CoinSpecification trait specifies the sub-coin for the corresponding usage context. It allows us to write the common logic of all sub-coins without the overhead and duplication.

Sub-coin:

• Signed - means that the coin should be signed by the owner, and the signature(witness) should be stored under the witness_index index in the witnesses vector of the crate::Transaction.
• Predicate - means that the coin is not signed, and the owner is a predicate bytecode. The merkle root from the predicate should be equal to the owner.
• Full - is used during the deserialization of the coin. It should be transformed into Signed or Predicate sub-coin. If the predicate is empty, it is Signed, else Predicate.

Fields

utxo_id: UtxoId

owner: Address

amount: Word

asset_id: AssetId

tx_pointer: TxPointer

witness_index: Specification::Witness

maturity: BlockHeight

predicate: Specification::Predicate

predicate_data: Specification::PredicateData

Implementations

impl<Specification> Coin<Specification>where Specification: CoinSpecification,

pub fn prepare_sign(&mut self)

The “Note” section from the specification: https://github.com/FuelLabs/fuel-specs/blob/master/src/protocol/tx_format/input.md#inputcoin.

impl Coin<Full>

pub fn into_signed(self) -> Coin<Signed>

pub fn into_predicate(self) -> Coin<Predicate>

Trait Implementations

impl<Specification> Clone for Coin<Specification>where Specification: CoinSpecification + Clone, Specification::Witness: Clone, Specification::Predicate: Clone, Specification::PredicateData: Clone,

fn clone(&self) -> Coin<Specification>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Specification> Debug for Coin<Specification>where Specification: CoinSpecification,

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

Formats the value using the given formatter.

impl<Specification> Default for Coin<Specification>where Specification: CoinSpecification + Default, Specification::Witness: Default, Specification::Predicate: Default, Specification::PredicateData: Default,

fn default() -> Coin<Specification>

Returns the “default value” for a type.

impl<Specification> Hash for Coin<Specification>where Specification: CoinSpecification + Hash, Specification::Witness: Hash, Specification::Predicate: Hash, Specification::PredicateData: Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Specification> PartialEq<Coin<Specification>> for Coin<Specification>where Specification: CoinSpecification + PartialEq, Specification::Witness: PartialEq, Specification::Predicate: PartialEq, Specification::PredicateData: PartialEq,

fn eq(&self, other: &Coin<Specification>) -> 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<Specification> Read for Coin<Specification>where Specification: CoinSpecification,

fn read(&mut self, full_buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<Specification> SizedBytes for Coin<Specification>where Specification: CoinSpecification,

fn serialized_size(&self) -> usize

Return the expected serialized size for an instance of the type.

impl<Specification> Write for Coin<Specification>where Specification: CoinSpecification,

fn write(&mut self, full_buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl<Specification> Eq for Coin<Specification>where Specification: CoinSpecification + Eq, Specification::Witness: Eq, Specification::Predicate: Eq, Specification::PredicateData: Eq,

impl<Specification> StructuralEq for Coin<Specification>where Specification: CoinSpecification,

impl<Specification> StructuralPartialEq for Coin<Specification>where Specification: CoinSpecification,