Struct AccountCodeUpgrade 

pub struct AccountCodeUpgrade { /* private fields */ }

An upgrade of the AccountCode of an existing account.

Warning

An upgrade does not change the account’s storage, so the new code must use the same storage layout as the current code. Otherwise, the account can become unusable. The kernel does not enforce this, so the account authority must make sure that the layout stays the same.

The kernel only learns the commitment of the new code, so the host must obtain the new code when the kernel initializes the upgrade. It looks for the code, encoded by AccountCodeUpgrade::to_elements, in the advice map under AccountCodeUpgrade::advice_map_key. Local transactions provide it e.g. via TransactionArgs::with_account_code_upgrade, while a note script can insert it during execution.

Implementations

impl AccountCodeUpgrade

pub fn new(code: AccountCode) -> Self

Returns a new AccountCodeUpgrade that upgrades the account to code.

pub fn advice_map_key(new_code_commitment: Word) -> Word

Returns the advice map key under which the upgrade to the code with new_code_commitment is provided.

The code commitment itself maps to the procedure roots of the code, so the upgrade is keyed by a domain-separated hash of the commitment instead.

pub fn code(&self) -> &AccountCode

Returns a reference to the new account code.

pub fn commitment(&self) -> Word

Returns the commitment of the new account code.

pub fn into_code(self) -> AccountCode

Consumes self and returns the new account code.

pub fn to_elements(&self) -> Vec<Felt>

Returns the encoding of the new code as field elements.

The serialized code is packed into field elements, 7 bytes per element, with a non-zero padding marker in the last packed element, and then padded with zero elements to a whole number of words, so that it can also be carried as words, e.g. in a note attachment.

pub fn to_advice_map_entry(&self) -> (Word, Vec<Felt>)

Returns the advice map entry that provides this upgrade to a transaction.

pub fn try_from_elements( elements: &[Felt], ) -> Result<Self, DeserializationError>

Decodes an AccountCodeUpgrade from the elements produced by AccountCodeUpgrade::to_elements.

Errors

Returns an error if elements do not encode valid account code.

Trait Implementations

impl Clone for AccountCodeUpgrade

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountCodeUpgrade

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

Formats the value using the given formatter.

impl Deserializable for AccountCodeUpgrade

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl Eq for AccountCodeUpgrade

impl PartialEq for AccountCodeUpgrade

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

Equality operator ==.

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

Inequality operator !=.

impl Serializable for AccountCodeUpgrade

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

impl StructuralPartialEq for AccountCodeUpgrade