Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
N
nebula
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
exchain
nebula
Commits
42fe6e62
Unverified
Commit
42fe6e62
authored
Jan 20, 2024
by
clabby
Committed by
GitHub
Jan 20, 2024
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve `IBigStepper` docs (#9118)
parent
e7058c94
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
10 additions
and
10 deletions
+10
-10
IBigStepper.sol
.../contracts-bedrock/src/dispute/interfaces/IBigStepper.sol
+10
-10
No files found.
packages/contracts-bedrock/src/dispute/interfaces/IBigStepper.sol
View file @
42fe6e62
...
...
@@ -4,8 +4,8 @@ pragma solidity ^0.8.15;
import { IPreimageOracle } from "src/cannon/interfaces/IPreimageOracle.sol";
/// @title IBigStepper
/// @notice
An interface for a contract with a state transition function that
///
will accept a pre state and return a post state
.
/// @notice
Describes a state machine that can perform a single instruction step, provided a prestate and an optional
///
proof
.
/// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
/// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣼⠶⢅⠒⢄⢔⣶⡦⣤⡤⠄⣀⠀⠀⠀⠀⠀⠀⠀
/// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠨⡏⠀⠀⠈⠢⣙⢯⣄⠀⢨⠯⡺⡘⢄⠀⠀⠀⠀⠀
...
...
@@ -25,13 +25,13 @@ import { IPreimageOracle } from "src/cannon/interfaces/IPreimageOracle.sol";
/// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠉⠉⠉⠙⠛⠻⠿⠿⠿⢿⣿⣿⣿⣷⣶⣶⣾⣿⣿⣿⣿⠿⠟⠁
/// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠈⠉⠉⠉⠉⠁⠀⠀⠀⠀⠀
interface IBigStepper {
/// @notice Performs
a single instruction step from a given prestate and returns the poststate
///
hash
.
/// @param _
stateData The preimage of the prestate hash.
///
@param _proof A proof for the inclusion of the prestate's memory in the merkle tree
.
/// @param _localContext The local key context for the preimage oracle. Optional, can be set as a constant
/// i
f the caller
only requires one set of local keys.
/// @return postState_ The
poststate hash after the instruction step
.
/// @notice Performs
the state transition from a given prestate and returns the hash of the post state witness.
///
@param _stateData The raw opaque prestate data
.
/// @param _
proof Opaque proof data, can be used to prove things about the prestate in relation to the state of the
///
interface's implementation
.
/// @param _localContext The local key context for the preimage oracle. Optional, can be set as a constant
if the
/// i
mplementation
only requires one set of local keys.
/// @return postState_ The
hash of the post state witness after the state transition
.
function step(
bytes calldata _stateData,
bytes calldata _proof,
...
...
@@ -40,6 +40,6 @@ interface IBigStepper {
external
returns (bytes32 postState_);
/// @notice Returns the preimage oracle used by the st
epper
.
/// @notice Returns the preimage oracle used by the st
ate machine
.
function oracle() external view returns (IPreimageOracle oracle_);
}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment