From 47879f064f005953e1de19ae34875d8477c0c78b Mon Sep 17 00:00:00 2001
From: Michael Benfield <mbenfield@offchainlabs.com>
Date: Tue, 12 Mar 2024 10:32:41 -0700
Subject: [PATCH] exit_early

---
 stylus-sdk/src/evm.rs    | 33 +++++++++++++++++++++++++++++----
 stylus-sdk/src/hostio.rs |  5 +++++
 2 files changed, 34 insertions(+), 4 deletions(-)

diff --git a/stylus-sdk/src/evm.rs b/stylus-sdk/src/evm.rs
index 9ade581..1a2b9fa 100644
--- a/stylus-sdk/src/evm.rs
+++ b/stylus-sdk/src/evm.rs
@@ -57,16 +57,41 @@ pub fn pay_for_memory_grow(pages: u16) {
     unsafe { hostio::pay_for_memory_grow(pages) }
 }
 
+/// Print the message to the console and revert, with revert data supplied by a call to `output`.
+#[macro_export]
+macro_rules! revert {
+    ($($x:tt)*) => {
+        ::stylus_sdk::console!($($x)*);
+        unsafe { ::stylus_sdk::evm::exit_early(1) };
+    }
+}
+
+/// Print the message to the console and exit successfully, with data supplied
+/// by a call to `output`.
+#[macro_export]
+macro_rules! succeed {
+    ($($x:tt)*) => {
+        ::stylus_sdk::console!($($x)*);
+        unsafe { ::stylus_sdk::evm::exit_early(0) };
+    }
+}
+
+/// Not intended for end users.
+#[inline]
+pub fn exit_early(status: u32) {
+    unsafe { hostio::exit_early(status) }
+}
+
 wrap_hostio!(
-    /// Gets the amount of gas remaining. See [`Ink and Gas`] for more information on Stylus's compute pricing.
+    /// Gets the amount of gas remaining. See [`Gas and Ink`] for more information on Stylus's compute pricing.
     ///
-    /// [`Ink and Gas`]: https://developer.arbitrum.io/TODO
+    /// [`Gas and Ink`]: https://docs.arbitrum.io/stylus/concepts/stylus-gas
     gas_left evm_gas_left u64
 );
 
 wrap_hostio!(
-    /// Gets the amount of ink remaining. See [`Ink and Gas`] for more information on Stylus's compute pricing.
+    /// Gets the amount of ink remaining. See [`Gas and Ink`] for more information on Stylus's compute pricing.
     ///
-    /// [`Ink and Gas`]: https://developer.arbitrum.io/TODO
+    /// [`Gas and Ink`]: https://docs.arbitrum.io/stylus/concepts/stylus-gas
     ink_left evm_ink_left u64
 );
diff --git a/stylus-sdk/src/hostio.rs b/stylus-sdk/src/hostio.rs
index 82792bf..2114c7c 100644
--- a/stylus-sdk/src/hostio.rs
+++ b/stylus-sdk/src/hostio.rs
@@ -286,6 +286,11 @@ extern "C" {
     /// naturally when `user_entrypoint` returns.
     pub fn write_result(data: *const u8, len: usize);
 
+    /// Exits program execution early with the given status code.
+    /// If `0`, the program returns successfully with any data supplied by `write_result`.
+    /// Otherwise, the program reverts and treats any `write_result` data as revert data.
+    pub fn exit_early(status: u32) -> !;
+
     /// Returns the length of the last EVM call or deployment return result, or `0` if neither have
     /// happened during the program's execution. The semantics are equivalent to that of the EVM's
     /// [`RETURN_DATA_SIZE`] opcode.