added docs

lmittmann · Jul 19, 2023 · 1a8aa46 · 1a8aa46
1 parent bea6108
commit 1a8aa46
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -221,6 +221,14 @@ List of supported RPC methods.
 | `debug_traceCall`        | `debug.TraceCall(msg *w3types.Message, blockNumber *big.Int, config *debug.TraceConfig).Returns(trace *debug.Trace)`<br>`debug.CallTraceCall(msg *w3types.Message, blockNumber *big.Int, overrides w3types.State).Returns(trace *debug.CallTrace)`
 | `debug_traceTransaction` | `debug.TraceTx(txHash common.Hash, config *debug.TraceConfig).Returns(trace *debug.Trace)`<br>`debug.CallTraceTx(txHash common.Hash, overrides w3types.State).Returns(trace *debug.CallTrace)`
 
+### [`txpool`](https://pkg.go.dev/github.com/lmittmann/w3/module/txpool)
+
+| Method               | Go Code
+| :--------------------| :-------
+| `txpool_content`     | `txpool.Content().Returns(resp *txpool.ContentResponse)`
+| `txpool_contentFrom` | `txpool.ContentFrom(addr common.Address).Returns(resp *txpool.ContentFromResponse)`
+| `txpool_status`      | `txpool.Status().Returns(resp *txpool.StatusResponse)`
+
 ### [`web3`](https://pkg.go.dev/github.com/lmittmann/w3/module/web3)
 
 | Method               | Go Code

diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx
@@ -239,6 +239,14 @@ List of supported RPC methods.
 | `debug_traceCall`        | `debug.TraceCall(msg *w3types.Message, blockNumber *big.Int, config *debug.TraceConfig).Returns(trace *debug.Trace)`<br />`debug.CallTraceCall(msg *w3types.Message, blockNumber *big.Int, overrides w3types.State).Returns(trace *debug.CallTrace)`
 | `debug_traceTransaction` | `debug.TraceTx(txHash common.Hash, config *debug.TraceConfig).Returns(trace *debug.Trace)`<br />`debug.CallTraceTx(txHash common.Hash, overrides w3types.State).Returns(trace *debug.CallTrace)`
 
+### [`txpool`](https://pkg.go.dev/github.com/lmittmann/w3/module/debug)
+
+| Method               | Go Code
+| :--------------------| :-------
+| `txpool_content`     | `txpool.Content().Returns(resp *txpool.ContentResponse)`
+| `txpool_contentFrom` | `txpool.ContentFrom(addr common.Address).Returns(resp *txpool.ContentFromResponse)`
+| `txpool_status`      | `txpool.Status().Returns(resp *txpool.StatusResponse)`
+
 ### [`web3`](https://pkg.go.dev/github.com/lmittmann/w3/module/web3)
 
 | Method               | Go Code

diff --git a/module/txpool/doc.go b/module/txpool/doc.go
@@ -0,0 +1,4 @@
+/*
+Package txpool implements RPC API bindings for methods in the "txpool" namespace.
+*/
+package txpool