📝 Extend license (#26)

LICENSE.md

@@ -1,7 +1,7 @@
-The MIT License (MIT)
-=====================
+# The MIT License (MIT)
 
 Copyright © `2023` `kona contributors`
+Copyright © `2024` `Optimism`
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.md

@@ -15,7 +15,6 @@
     <img src="https://img.shields.io/badge/Contributor%20Book-grey?logo=mdBook" alt="Book">
   </a>
   <a href="https://github.com/ethereum-optimism/monorepo"><img src="https://img.shields.io/badge/OP%20Stack-monorepo-red" alt="OP Stack"></a>
-  <a href="https://t.me/+2yfSX0YikWMxNTRh"><img src="https://img.shields.io/badge/Telegram-x?logo=telegram&label=anton-rs%20contributors"></a>
 </p>
 
 <p align="center">

crates/preimage/src/traits.rs

@@ -6,15 +6,27 @@ use anyhow::Result;
 pub trait PreimageOracleClient {
     /// Get the data corresponding to the currently set key from the host. Return the data in a new heap allocated
     /// `Vec<u8>`
+    ///
+    /// # Returns
+    /// - `Ok(Vec<u8>)` if the data was successfully fetched from the host.
+    /// - `Err(_)` if the data could not be fetched from the host.
     fn get(&mut self, key: PreimageKey) -> Result<Vec<u8>>;
 
-    /// Get the data corresponding to the currently set key from the host. Write the data into the provided buffer
+    /// Get the data corresponding to the currently set key from the host. Writes the data into the provided buffer.
+    ///
+    /// # Returns
+    /// - `Ok(())` if the data was successfully written into the buffer.
+    /// - `Err(_)` if the data could not be written into the buffer.
     fn get_exact(&mut self, key: PreimageKey, buf: &mut [u8]) -> Result<()>;
 }
 
 /// A [HintWriterClient] is a high-level interface to the hint pipe. It provides a way to write hints to the host.
 pub trait HintWriterClient {
     /// Write a hint to the host. This will overwrite any existing hint in the pipe, and block until all data has been
     /// written.
+    ///
+    /// # Returns
+    /// - `Ok(())` if the hint was successfully written to the host.
+    /// - `Err(_)` if the hint could not be written to the host.
     fn write(&self, hint: &str) -> Result<()>;
 }