fuels_programs::contract

Struct Contract

source 
pub struct Contract<Code> { /* private fields */ }
Expand description

Represents a contract that can be deployed either directly (Contract::regular) or through a loader Contract::convert_to_loader. Provides the ability to calculate the ContractId (Contract::contract_id) without needing to deploy the contract. This struct also manages contract code updates with configurables (Contract::with_configurables) and can automatically load storage slots (via Contract::load_from).

Implementations§

source§

impl Contract<Regular>

source

pub fn with_code(self, code: Vec<u8>) -> Self

source

pub fn with_configurables(self, configurables: impl Into<Configurables>) -> Self

source

pub fn code(&self) -> Vec<u8> ⓘ

source

pub fn contract_id(&self) -> ContractId

source

pub fn code_root(&self) -> Bytes32

source

pub fn state_root(&self) -> Bytes32

source

pub fn load_from( binary_filepath: impl AsRef<Path>, config: LoadConfiguration, ) -> Result<Contract<Regular>>

Loads a contract from a binary file. Salt and storage slots are loaded as well, depending on the configuration provided.

source

pub fn regular( code: Vec<u8>, salt: Salt, storage_slots: Vec<StorageSlot>, ) -> Contract<Regular>

Creates a regular contract with the given code, salt, and storage slots.

source

pub async fn deploy( self, account: &impl Account, tx_policies: TxPolicies, ) -> Result<Bech32ContractId>

Deploys a compiled contract to a running node. To deploy a contract, you need an account with enough assets to pay for deployment. This account will also receive the change.

source

pub fn convert_to_loader( self, max_words_per_blob: usize, ) -> Result<Contract<Loader<BlobsNotUploaded>>>

Converts a regular contract into a loader contract, splitting the code into blobs.

source

pub async fn smart_deploy( self, account: &impl Account, tx_policies: TxPolicies, max_words_per_blob: usize, ) -> Result<Bech32ContractId>

Deploys the contract either as a regular contract or as a loader contract if it exceeds the size limit.

source§

impl Contract<Loader<BlobsNotUploaded>>

source

pub fn code(&self) -> Vec<u8> ⓘ

source

pub fn contract_id(&self) -> ContractId

source

pub fn code_root(&self) -> Bytes32

source

pub fn state_root(&self) -> Bytes32

source

pub fn loader_from_blobs( blobs: Vec<Blob>, salt: Salt, storage_slots: Vec<StorageSlot>, ) -> Result<Self>

Creates a loader contract for the code found in blobs. Calling deploy on this contract does two things:

  1. Uploads the code blobs.
  2. Deploys the loader contract.

The loader contract, when executed, will load all the given blobs into memory and delegate the call to the original contract code contained in the blobs.

source

pub fn blobs(&self) -> &[Blob]

source

pub fn blob_ids(&self) -> Vec<BlobId>

source

pub async fn upload_blobs( self, account: &impl Account, tx_policies: TxPolicies, ) -> Result<Contract<Loader<BlobsUploaded>>>

Uploads the blobs associated with this contract. Calling deploy on the result will only deploy the loader contract.

source

pub async fn deploy( self, account: &impl Account, tx_policies: TxPolicies, ) -> Result<Bech32ContractId>

Deploys the loader contract after uploading the code blobs.

source

pub fn revert_to_regular(self) -> Contract<Regular>

Reverts the contract from a loader contract back to a regular contract.

source§

impl Contract<Loader<BlobsUploaded>>

source

pub fn code(&self) -> Vec<u8> ⓘ

source

pub fn contract_id(&self) -> ContractId

source

pub fn code_root(&self) -> Bytes32

source

pub fn state_root(&self) -> Bytes32

source

pub fn compute_roots(&self) -> (ContractId, Bytes32, Bytes32)

source

pub fn loader_from_blob_ids( blob_ids: Vec<BlobId>, salt: Salt, storage_slots: Vec<StorageSlot>, ) -> Result<Self>

Creates a loader contract using previously uploaded blobs.

The contract code has been uploaded in blobs with BlobIds specified in blob_ids. This will create a loader contract that, when deployed and executed, will load all the specified blobs into memory and delegate the call to the code contained in the blobs.

source

pub fn blob_ids(&self) -> &[BlobId]

source

pub async fn deploy( self, account: &impl Account, tx_policies: TxPolicies, ) -> Result<Bech32ContractId>

Deploys the loader contract.

source§

impl<T> Contract<T>

source

pub fn salt(&self) -> Salt

source

pub fn with_salt(self, salt: impl Into<Salt>) -> Self

source

pub fn storage_slots(&self) -> &[StorageSlot]

source

pub fn with_storage_slots(self, storage_slots: Vec<StorageSlot>) -> Self

Trait Implementations§

source§

impl<Code: Clone> Clone for Contract<Code>

source§

fn clone(&self) -> Contract<Code>

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
source§

impl<Code: Debug> Debug for Contract<Code>

source§

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

Formats the value using the given formatter. Read more
source§

impl<Code: PartialEq> PartialEq for Contract<Code>

source§

fn eq(&self, other: &Contract<Code>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl<Code> StructuralPartialEq for Contract<Code>

Auto Trait Implementations§

§

impl<Code> Freeze for Contract<Code>
where Code: Freeze,

§

impl<Code> RefUnwindSafe for Contract<Code>
where Code: RefUnwindSafe,

§

impl<Code> Send for Contract<Code>
where Code: Send,

§

impl<Code> Sync for Contract<Code>
where Code: Sync,

§

impl<Code> Unpin for Contract<Code>
where Code: Unpin,

§

impl<Code> UnwindSafe for Contract<Code>
where Code: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AnyDebug for T
where T: Any + Debug,

source§

fn as_any_ref(&self) -> &(dyn Any + 'static)

Returns a reference to the underlying type as Any.
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> Conv for T

source§

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

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

impl<T> FmtForward for T

source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<S> IteratorOverTable for S

source§

fn iter_all_keys<M>( &self, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<<M as Mappable>::OwnedKey, Error>>
where M: Mappable, Self: IterableTable<M>,

Returns an iterator over the all keys in the table.
source§

fn iter_all_by_prefix_keys<M, P>( &self, prefix: Option<P>, ) -> BoxedIter<'_, Result<<M as Mappable>::OwnedKey, Error>>
where M: Mappable, P: AsRef<[u8]>, Self: IterableTable<M>,

Returns an iterator over the all keys in the table with the specified prefix.
source§

fn iter_all_by_start_keys<M>( &self, start: Option<&<M as Mappable>::Key>, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<<M as Mappable>::OwnedKey, Error>>
where M: Mappable, Self: IterableTable<M>,

Returns an iterator over the all keys in the table after a specific start key.
source§

fn iter_all_filtered_keys<M, P>( &self, prefix: Option<P>, start: Option<&<M as Mappable>::Key>, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<<M as Mappable>::OwnedKey, Error>>
where M: Mappable, P: AsRef<[u8]>, Self: IterableTable<M>,

Returns an iterator over the all keys in the table with a prefix after a specific start key.
source§

fn iter_all<M>( &self, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<(<M as Mappable>::OwnedKey, <M as Mappable>::OwnedValue), Error>>
where M: Mappable, Self: IterableTable<M>,

Returns an iterator over the all entries in the table.
source§

fn iter_all_by_prefix<M, P>( &self, prefix: Option<P>, ) -> BoxedIter<'_, Result<(<M as Mappable>::OwnedKey, <M as Mappable>::OwnedValue), Error>>
where M: Mappable, P: AsRef<[u8]>, Self: IterableTable<M>,

Returns an iterator over the all entries in the table with the specified prefix.
source§

fn iter_all_by_start<M>( &self, start: Option<&<M as Mappable>::Key>, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<(<M as Mappable>::OwnedKey, <M as Mappable>::OwnedValue), Error>>
where M: Mappable, Self: IterableTable<M>,

Returns an iterator over the all entries in the table after a specific start key.
source§

fn iter_all_filtered<M, P>( &self, prefix: Option<P>, start: Option<&<M as Mappable>::Key>, direction: Option<IterDirection>, ) -> BoxedIter<'_, Result<(<M as Mappable>::OwnedKey, <M as Mappable>::OwnedValue), Error>>
where M: Mappable, P: AsRef<[u8]>, Self: IterableTable<M>,

Returns an iterator over the all entries in the table with a prefix after a specific start key.
source§

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

source§

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
source§

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
source§

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
source§

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

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

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

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

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

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

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

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

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.
source§

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.
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> StorageAsMut for T

source§

fn storage<Type>(&mut self) -> StorageMut<'_, Self, Type>
where Type: Mappable,

source§

fn storage_as_mut<Type>(&mut self) -> StorageMut<'_, Self, Type>
where Type: Mappable,

source§

impl<T> StorageAsRef for T

source§

fn storage<Type>(&self) -> StorageRef<'_, Self, Type>
where Type: Mappable,

source§

fn storage_as_ref<Type>(&self) -> StorageRef<'_, Self, Type>
where Type: Mappable,

source§

impl<T> Tap for T

source§

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

Immutable access to a value. Read more
source§

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

Mutable access to a value. Read more
source§

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

Immutable access to the Borrow<B> of a value. Read more
source§

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

Mutable access to the BorrowMut<B> of a value. Read more
source§

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
source§

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
source§

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
source§

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
source§

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

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

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

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

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

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

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

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

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.
source§

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.
source§

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.
source§

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.
source§

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

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

impl<T> TryConv for T

source§

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

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

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

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> IsFieldType<T> for T