docs: adds documentationt to readme

Author: ant4g0nist

.gitignore

@@ -60,4 +60,7 @@ pyvenv.cfg
 pip-selfcheck.json
 
 # Sensitive or high-churn files:
-*.key
+*.key
+
+### llvm
+llvm-project

CREDITS.md

@@ -0,0 +1,3 @@
+Thanks to:
+- [atheris](github/google/atheris) by google
+- [pytezos](https://github.com/baking-bad/pytezos) by Baking bad

README.md

@@ -44,7 +44,7 @@ def chinfuzzStartFuzzer(args, env):
 
     spinner.succeed(text="Fuzzer initialized")
 
-    _fuzz.runOneFuzzer()
+    _fuzz.runOneFuzzer(lib_fuzzer_args=lib_fuzzer_args)
 
 
 def chinfuzzReplayFuzzer(args, env):
@@ -126,7 +126,15 @@ def main(args, env=os.environ):
         parser.print_help()
         exit(1)
 
-    args = parser.parse_args(args[1:])
+    # this is an 'internal' method
+    args, unknown = parser.parse_known_args()
+    global lib_fuzzer_args
+    lib_fuzzer_args = []
+    for arg in unknown:
+        if arg == "--":
+            lib_fuzzer_args = unknown[unknown.index(arg)+1:]
+            break
+
     return args.func(args, env)
 
 if __name__ == "__main__":

chinfuzz/__init__.py

@@ -85,18 +85,19 @@ def getDataProvider(self, data, **kwargs):
         """
         return atheris.FuzzedDataProvider(data)
 
-    def runOneFuzzer(self):
+    def runOneFuzzer(self, lib_fuzzer_args=[]):
         sys.path.append(f"fuzz")
         name = pathlib.Path(self.args.fuzz).stem
         with io.StringIO() as buff:
             with contextlib.redirect_stderr(buff):
                 with atheris.instrument_imports():         
                     fuzz = __import__(name)
 
-        self.callChinfuzzFuzzerTestOneInput(fuzz, self.args.fuzz)
+        self.callChinfuzzFuzzerTestOneInput(fuzz, self.args.fuzz, lib_fuzzer_args)
 
-    def callChinfuzzFuzzerTestOneInput(self, fuzz, fuzzer):
-        args = [fuzzer]
+    def callChinfuzzFuzzerTestOneInput(self, fuzz, fuzzer, lib_fuzzer_args=[]):
+        args = [fuzzer] + lib_fuzzer_args
+        
         if self.args.corpus:
             args.append(self.args.corpus)
 

chinfuzz/core/fuzz.py

@@ -7,9 +7,13 @@
 def ChinfuzzFuzzerTestOneInput(data):
     # convert data (bytes) to required data type using FuzzedDataProvider
     fdp = fuzz.FuzzedDataProvider(data)
-    # we generate
-    data = fdp.ConsumeInt(10000000)
+    
+    # we generate numbers of size `10000`
+    data = fdp.ConsumeInt(10000)
 
+    # we get the contract interface as we do in Chinstrap tests
     contract = getContractInterface("SampleContract")
+
+    # we initialise the storate and call the entrypoint we would like to fuzz
     storage = {"owner": owner, "counter": 0}
     contract.increment(data).interpret(storage=storage, source=owner)