Solidity and Natspec Linters (#64)

* feat: added solity and natspec linters and formatted solidity

* fix: trigger name in wasi component

---------

Co-authored-by: Reece Williams <reecepbcups@gmail.com>

Author: daopunk

.gitignore

@@ -6,3 +6,4 @@ compiled/*.wasm
 .docker/*.json
 .env
 node_modules/
+lcov.info

.solhint.json

@@ -0,0 +1,14 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["warn"],
+    "quotes": "off",
+    "func-visibility": ["warn", { "ignoreConstructors": true }],
+    "no-inline-assembly": "off",
+    "no-empty-blocks": "off",
+    "private-vars-leading-underscore": ["warn", { "strict": false }],
+    "ordering": "warn",
+    "avoid-low-level-calls": "off",
+    "named-parameters-mapping": "warn"
+  }
+}

components/eth-price-oracle/src/bindings.rs

@@ -5,8 +5,7 @@ pub type TriggerAction = wavs::worker::layer_types::TriggerAction;
 #[doc(hidden)]
 #[allow(non_snake_case)]
 pub unsafe fn _export_run_cabi<T: Guest>(arg0: *mut u8) -> *mut u8 {
-    #[cfg(target_arch = "wasm32")]
-    _rt::run_ctors_once();
+    #[cfg(target_arch = "wasm32")] _rt::run_ctors_once();
     let l0 = *arg0.add(0).cast::<*mut u8>();
     let l1 = *arg0.add(4).cast::<usize>();
     let len2 = l1;
@@ -608,8 +607,11 @@ pub mod host {
                                         let l7 = *ptr1.add(16).cast::<*mut u8>();
                                         let l8 = *ptr1.add(20).cast::<usize>();
                                         let len9 = l8;
-                                        let bytes9 =
-                                            _rt::Vec::from_raw_parts(l7.cast(), len9, len9);
+                                        let bytes9 = _rt::Vec::from_raw_parts(
+                                            l7.cast(),
+                                            len9,
+                                            len9,
+                                        );
                                         _rt::string_lift(bytes9)
                                     };
                                     Some(e)
@@ -623,8 +625,11 @@ pub mod host {
                                         let l11 = *ptr1.add(28).cast::<*mut u8>();
                                         let l12 = *ptr1.add(32).cast::<usize>();
                                         let len13 = l12;
-                                        let bytes13 =
-                                            _rt::Vec::from_raw_parts(l11.cast(), len13, len13);
+                                        let bytes13 = _rt::Vec::from_raw_parts(
+                                            l11.cast(),
+                                            len13,
+                                            len13,
+                                        );
                                         _rt::string_lift(bytes13)
                                     };
                                     Some(e)
@@ -690,8 +695,11 @@ pub mod host {
                                         let l7 = *ptr1.add(16).cast::<*mut u8>();
                                         let l8 = *ptr1.add(20).cast::<usize>();
                                         let len9 = l8;
-                                        let bytes9 =
-                                            _rt::Vec::from_raw_parts(l7.cast(), len9, len9);
+                                        let bytes9 = _rt::Vec::from_raw_parts(
+                                            l7.cast(),
+                                            len9,
+                                            len9,
+                                        );
                                         _rt::string_lift(bytes9)
                                     };
                                     Some(e)
@@ -705,8 +713,11 @@ pub mod host {
                                         let l11 = *ptr1.add(28).cast::<*mut u8>();
                                         let l12 = *ptr1.add(32).cast::<usize>();
                                         let len13 = l12;
-                                        let bytes13 =
-                                            _rt::Vec::from_raw_parts(l11.cast(), len13, len13);
+                                        let bytes13 = _rt::Vec::from_raw_parts(
+                                            l11.cast(),
+                                            len13,
+                                            len13,
+                                        );
                                         _rt::string_lift(bytes13)
                                     };
                                     Some(e)
@@ -720,8 +731,11 @@ pub mod host {
                                         let l15 = *ptr1.add(40).cast::<*mut u8>();
                                         let l16 = *ptr1.add(44).cast::<usize>();
                                         let len17 = l16;
-                                        let bytes17 =
-                                            _rt::Vec::from_raw_parts(l15.cast(), len17, len17);
+                                        let bytes17 = _rt::Vec::from_raw_parts(
+                                            l15.cast(),
+                                            len17,
+                                            len17,
+                                        );
                                         _rt::string_lift(bytes17)
                                     };
                                     Some(e)

components/eth-price-oracle/src/trigger.rs

@@ -12,7 +12,7 @@ pub fn decode_trigger_event(trigger_data: TriggerData) -> Result<(u64, Vec<u8>,
     match trigger_data {
         TriggerData::EthContractEvent(TriggerDataEthContractEvent { log, .. }) => {
             let event: solidity::NewTrigger = decode_event_log_data!(log)?;
-            let trigger_info = solidity::TriggerInfo::abi_decode(&event._0, false)?;
+            let trigger_info = solidity::TriggerInfo::abi_decode(&event._triggerInfo, false)?;
             Ok((trigger_info.triggerId, trigger_info.data.to_vec(), Destination::Ethereum))
         }
         TriggerData::Raw(data) => Ok((0, data.clone(), Destination::CliOutput)),

natspec-smells.config.js

@@ -0,0 +1,9 @@
+/**
+ * List of supported options: https://github.com/defi-wonderland/natspec-smells?tab=readme-ov-file#options
+ */
+
+/** @type {import('@defi-wonderland/natspec-smells').Config} */
+module.exports = {
+  include: 'src/**/*.sol',
+  exclude: '(test|scripts)/**/*.sol',
+};