Skip to main content

NeoRuntime

Struct NeoRuntime 

Source
pub struct NeoRuntime { /* private fields */ }
Expand description

Neo runtime for executing compiled Yul contracts

Implementations§

Source§

impl NeoRuntime

Source

pub fn enable_debugging(&mut self)

Enable debugging mode

Source

pub fn disable_debugging(&mut self)

Disable debugging mode

Source

pub fn set_breakpoint(&mut self, instruction_pointer: u32)

Set breakpoint at instruction

Source

pub fn remove_breakpoint(&mut self, instruction_pointer: u32)

Remove breakpoint

Source

pub fn step(&mut self) -> Result<StepResult, RuntimeError>

Step through execution

Source§

impl NeoRuntime

Source

pub fn deploy_contract( &mut self, bytecode: &[u8], constructor_args: &[u8], ) -> Result<String, RuntimeError>

Deploy contract and return address

Source§

impl NeoRuntime

Source

pub fn override_block_height(&mut self, height: u64)

Override block height for the next execution.

Source

pub fn override_timestamp(&mut self, timestamp: u64)

Override timestamp for the next execution.

Source

pub fn override_caller_account( &mut self, account: &str, ) -> Result<(), RuntimeError>

Override caller script hash for the next execution.

Source

pub fn override_value(&mut self, value: u64)

Task #113 — Override Solidity msg.value for the next execution.

Neo N3 has no native attached-value concept, so compiled MsgValue reads default to 0. This override lets harnesses drive msg.value to a specific u64 for payable-fallback / NEP-17 onPayment test scenarios. Drained after the next execution (mirrors override_timestamp / override_block_height).

Source

pub fn execute_with_overrides( &mut self, bytecode: &[u8], input: &[u8], overrides: &ExecutionOverrides, ) -> Result<ExecutionResult, RuntimeError>

Execute bytecode with optional metadata overrides applied to this invocation.

Source

pub fn new(config: RuntimeConfig) -> Result<Self, RuntimeError>

Create new runtime instance

Source

pub fn execute( &mut self, bytecode: &[u8], input: &[u8], ) -> Result<ExecutionResult, RuntimeError>

Execute bytecode with given input

Source

pub fn execute_with_tokens( &mut self, bytecode: &[u8], input: &[u8], tokens: &[MethodToken], ) -> Result<ExecutionResult, RuntimeError>

Execute bytecode with a NEF method token table.

This is required when the script contains the CALLT opcode (0x37).

Source

pub fn call_function( &mut self, bytecode: &[u8], function_name: &str, args: &[StackItem], ) -> Result<ExecutionResult, RuntimeError>

Call specific function with arguments

Source

pub fn call_method( &mut self, bytecode: &[u8], tokens: &[MethodToken], manifest: &Value, method_name: &str, args: &[StackItem], ) -> Result<ExecutionResult, RuntimeError>

Invoke a named method on a compiled Neo DevPack for Solidity contract.

Unlike call_function, which cannot reach anything past the first public method of a multi-method contract, this helper (Task #19):

  1. Runs _deploy(null, false) once per NeoRuntime instance so that state-variable initializers populate storage before any user call observes the contract (Task #47: state-var initializers did not run under the execute/call_function paths — this subsumes it).
  2. Looks up the target method’s offset from manifest.abi.methods[].offset (emitted by the compiler at src/cli/bytecode/bytecode_core.rs:120) and starts execution at that offset rather than always at bytecode[0].
  3. Pushes args in reverse onto the NeoVM evaluation stack so that the INITSLOT locals, args prologue emitted by each compiled method (opcode 0x57, handler at instruction/slots.rs:4) pops them into the method’s argument slots in declaration order.

The persisted storage lives in storage_manager; bridge::execute flushes the storage_overlay via storage.commit(..) on halt, so subsequent call_method invocations on the same NeoRuntime observe deploy-time writes.

tokens is the NEF method-token table carried alongside the bytecode (see CompilationArtifacts::tokens); pass an empty slice for scripts that do not use CALLT.

Source

pub fn call_method_with_deploy_args( &mut self, bytecode: &[u8], tokens: &[MethodToken], manifest: &Value, method_name: &str, args: &[StackItem], deploy_args: Option<&[StackItem]>, ) -> Result<ExecutionResult, RuntimeError>

Task #81: Invoke a named method like call_method, but pass deploy_args through the auto-fired _deploy(data, update) trigger as the data parameter.

deploy_args wires constructor arguments for contracts whose Solidity constructor(...) takes parameters. When deploy_args = Some(&[..]), the slice is wrapped in a StackItem::Array and passed as data; the compiled _deploy prologue then decodes it (jsonDeserialize/deserialize fallbacks throw on Array inputs, so the original Array flows through unchanged to PICKITEM / ArrayGet for constructor-argument extraction, see src/ir/ir_deploy.rs:112).

When deploy_args = None, behavior matches pre-Task #81 call_method: data = Null, suitable for no-arg constructors.

update is always Boolean(false) here (this is a first-deployment trigger, not a contract update).

Source§

impl NeoRuntime

Source

pub fn get_state_snapshot(&self) -> StateSnapshot

Get current state of the runtime

Source

pub fn restore_state( &mut self, snapshot: StateSnapshot, ) -> Result<(), RuntimeError>

Restore state from snapshot

Source

pub fn get_storage( &mut self, account: &str, key: &[u8], ) -> Result<Option<Vec<u8>>, RuntimeError>

Get storage value for account and key

Source

pub fn set_storage( &mut self, account: &str, key: &[u8], value: &[u8], ) -> Result<(), RuntimeError>

Set storage value for account and key

Source

pub fn storage_find( &mut self, account: &str, prefix: &[u8], ) -> Result<Vec<(Vec<u8>, Vec<u8>)>, RuntimeError>

Find all storage (key, value) pairs for account whose keys start with prefix, returned in byte-lexicographic key order.

Delegates to StorageManager::query with an explicit prefix filter; an empty prefix slice matches every key for the account (common “scan all” pattern used by Neo N3 storage iterators).

Source

pub fn get_balance(&self, account: &str) -> Result<u64, RuntimeError>

Get account balance

Source

pub fn set_balance( &mut self, account: &str, balance: u64, ) -> Result<(), RuntimeError>

Set account balance

Source

pub fn get_statistics(&self) -> RuntimeStatistics

Get runtime statistics

Trait Implementations§

Source§

impl Debug for NeoRuntime

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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> 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, 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<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> 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> 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.