-
Notifications
You must be signed in to change notification settings - Fork 766
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: capture unknown fields (#1423)
* feat(core): add OtherFields type * feat: capture unknown fields * chore: update CHANGELOG * test: update tests * docs: fix doc tests * fix: make docs compile on stable
- Loading branch information
Showing
5 changed files
with
188 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -63,3 +63,6 @@ pub use proof::*; | |
|
|
||
| mod fee; | ||
| pub use fee::*; | ||
|
|
||
| mod other; | ||
| pub use other::OtherFields; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| //! Support for capturing other fields | ||
| use serde::{de::DeserializeOwned, Deserialize, Serialize}; | ||
| use serde_json::Map; | ||
| use std::{collections::BTreeMap, ops::Deref}; | ||
|
|
||
| /// A type that is supposed to capture additional fields that are not native to ethereum but included in ethereum adjacent networks, for example fields the [optimism `eth_getTransactionByHash` request](https://docs.alchemy.com/alchemy/apis/optimism/eth-gettransactionbyhash) returns additional fields that this type will capture | ||
| /// | ||
| /// This type is supposed to be used with [`#[serde(flatten)`](https://serde.rs/field-attrs.html#flatten) | ||
| #[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize, Default)] | ||
| #[serde(transparent)] | ||
| pub struct OtherFields { | ||
| /// Contains all unknown fields | ||
| inner: BTreeMap<String, serde_json::Value>, | ||
| } | ||
|
|
||
| // === impl OtherFields === | ||
|
|
||
| impl OtherFields { | ||
| /// Returns the deserialized value of the field, if it exists. | ||
| /// Deserializes the value with the given closure | ||
| /// | ||
| /// ``` | ||
| /// # use ethers_core::types::{OtherFields, U64}; | ||
| /// fn d(other: OtherFields) { | ||
| /// let l1_block_number = other.get_with("l1BlockNumber", |value| serde_json::from_value::<U64>(value)).unwrap().unwrap(); | ||
| /// # } | ||
| /// ``` | ||
| pub fn get_with<F, V>(&self, key: impl AsRef<str>, with: F) -> Option<V> | ||
| where | ||
| F: FnOnce(serde_json::Value) -> V, | ||
| { | ||
| self.inner.get(key.as_ref()).cloned().map(with) | ||
| } | ||
|
|
||
| /// Returns the deserialized value of the field, if it exists | ||
| /// | ||
| /// ``` | ||
| /// # use ethers_core::types::{OtherFields, U64}; | ||
| /// fn d(other: OtherFields) { | ||
| /// let l1_block_number: U64 = other.get_deserialized("l1BlockNumber").unwrap().unwrap(); | ||
| /// # } | ||
| /// ``` | ||
| pub fn get_deserialized<V: DeserializeOwned>( | ||
| &self, | ||
| key: impl AsRef<str>, | ||
| ) -> Option<serde_json::Result<V>> { | ||
| self.inner.get(key.as_ref()).cloned().map(serde_json::from_value) | ||
| } | ||
|
|
||
| /// Removes the deserialized value of the field, if it exists | ||
| /// | ||
| /// ``` | ||
| /// # use ethers_core::types::{OtherFields, U64}; | ||
| /// fn d(mut other: OtherFields) { | ||
| /// let l1_block_number: U64 = other.remove_deserialized("l1BlockNumber").unwrap().unwrap(); | ||
| /// assert!(!other.contains_key("l1BlockNumber")); | ||
| /// # } | ||
| /// ``` | ||
| /// | ||
| /// **Note:** this will also remove the value if deserializing it resulted in an error | ||
| pub fn remove_deserialized<V: DeserializeOwned>( | ||
| &mut self, | ||
| key: impl AsRef<str>, | ||
| ) -> Option<serde_json::Result<V>> { | ||
| self.inner.remove(key.as_ref()).map(serde_json::from_value) | ||
| } | ||
|
|
||
| /// Removes the deserialized value of the field, if it exists. | ||
| /// Deserializes the value with the given closure | ||
| /// | ||
| /// ``` | ||
| /// # use ethers_core::types::{OtherFields, U64}; | ||
| /// fn d(mut other: OtherFields) { | ||
| /// let l1_block_number: U64 = other.remove_with("l1BlockNumber", |value| serde_json::from_value(value)).unwrap().unwrap(); | ||
| /// # } | ||
| /// ``` | ||
| /// **Note:** this will also remove the value if deserializing it resulted in an error | ||
| pub fn remove_with<F, V>(&mut self, key: impl AsRef<str>, with: F) -> Option<V> | ||
| where | ||
| F: FnOnce(serde_json::Value) -> V, | ||
| { | ||
| self.inner.remove(key.as_ref()).map(with) | ||
| } | ||
|
|
||
| /// Removes the deserialized value of the field, if it exists and also returns the key | ||
| /// | ||
| /// ``` | ||
| /// # use ethers_core::types::{OtherFields, U64}; | ||
| /// fn d(mut other: OtherFields) { | ||
| /// let (key, l1_block_number_result) : (_, serde_json::Result<U64>) = other.remove_entry_deserialized("l1BlockNumber").unwrap(); | ||
| /// let l1_block_number = l1_block_number_result.unwrap(); | ||
| /// assert!(!other.contains_key("l1BlockNumber")); | ||
| /// # } | ||
| /// ``` | ||
| /// | ||
| /// **Note:** this will also remove the value if deserializing it resulted in an error | ||
| pub fn remove_entry_deserialized<V: DeserializeOwned>( | ||
| &mut self, | ||
| key: impl AsRef<str>, | ||
| ) -> Option<(String, serde_json::Result<V>)> { | ||
| self.inner | ||
| .remove_entry(key.as_ref()) | ||
| .map(|(key, value)| (key, serde_json::from_value(value))) | ||
| } | ||
|
|
||
| /// Deserialized this type into another container type | ||
| /// | ||
| /// ``` | ||
| /// use ethers_core::types::{Address, OtherFields, U64}; | ||
| /// use serde::Deserialize; | ||
| /// # fn d(mut other: OtherFields) { | ||
| /// | ||
| /// /// Additional Optimism transaction fields | ||
| /// #[derive(Deserialize)] | ||
| /// #[serde(rename_all = "camelCase")] | ||
| /// struct OptimismExtraFields { | ||
| /// pub l1_tx_origin : Option<Address>, | ||
| /// pub l1_timestamp : U64, | ||
| /// pub l1_block_number : U64, | ||
| /// } | ||
| /// | ||
| /// let optimism: OptimismExtraFields = other.deserialize_into().unwrap(); | ||
| /// # } | ||
| /// ``` | ||
| pub fn deserialize_into<T: DeserializeOwned>(self) -> serde_json::Result<T> { | ||
| let mut map = Map::with_capacity(self.inner.len()); | ||
| map.extend(self); | ||
| serde_json::from_value(serde_json::Value::Object(map)) | ||
| } | ||
| } | ||
|
|
||
| impl Deref for OtherFields { | ||
| type Target = BTreeMap<String, serde_json::Value>; | ||
|
|
||
| #[inline] | ||
| fn deref(&self) -> &BTreeMap<String, serde_json::Value> { | ||
| self.as_ref() | ||
| } | ||
| } | ||
|
|
||
| impl AsRef<BTreeMap<String, serde_json::Value>> for OtherFields { | ||
| fn as_ref(&self) -> &BTreeMap<String, serde_json::Value> { | ||
| &self.inner | ||
| } | ||
| } | ||
|
|
||
| impl IntoIterator for OtherFields { | ||
| type Item = (String, serde_json::Value); | ||
| type IntoIter = std::collections::btree_map::IntoIter<String, serde_json::Value>; | ||
|
|
||
| fn into_iter(self) -> Self::IntoIter { | ||
| self.inner.into_iter() | ||
| } | ||
| } | ||
|
|
||
| impl<'a> IntoIterator for &'a OtherFields { | ||
| type Item = (&'a String, &'a serde_json::Value); | ||
| type IntoIter = std::collections::btree_map::Iter<'a, String, serde_json::Value>; | ||
|
|
||
| fn into_iter(self) -> Self::IntoIter { | ||
| self.as_ref().iter() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters