From c93946701ac2becc5407a373fe7258eb03d46500 Mon Sep 17 00:00:00 2001
From: Ryan Schneider <ryanleeschneider@gmail.com>
Date: Thu, 12 Sep 2024 17:25:31 -0700
Subject: [PATCH] fixup: Switch to "Nonce Management" page

---
 .../eth-gettransactioncount                   |  7 --
 docs/flashbots-protect/nonce-management.mdx   | 82 +++++++++++++++++++
 docs/sidebars.js                              |  1 +
 3 files changed, 83 insertions(+), 7 deletions(-)
 delete mode 100644 docs/flashbots-protect/additional-documentation/eth-gettransactioncount
 create mode 100644 docs/flashbots-protect/nonce-management.mdx

diff --git a/docs/flashbots-protect/additional-documentation/eth-gettransactioncount b/docs/flashbots-protect/additional-documentation/eth-gettransactioncount
deleted file mode 100644
index bd855e9e..00000000
--- a/docs/flashbots-protect/additional-documentation/eth-gettransactioncount
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: eth_getTransactionCount
----
-
-When sending the `eth_getTransactionCount` RPC, users should sign their requests following our `X-Flashbots-Signature` standard to be able to their current `pending` transaction count.
-
-More details here after I confirm the page renders.
diff --git a/docs/flashbots-protect/nonce-management.mdx b/docs/flashbots-protect/nonce-management.mdx
new file mode 100644
index 00000000..f94f3641
--- /dev/null
+++ b/docs/flashbots-protect/nonce-management.mdx
@@ -0,0 +1,82 @@
+---
+title: Nonce Management
+---
+
+Normally, a wallet can call `eth_getTransactionCount` to get the next nonce to use for a transaction. 
+However, since transactions sent to Flashbots Protect are potentially sensitive, even exposing the incremented nonce can leak information about the user's activity.
+
+As such, Flashbots Protect requires that all requests to `eth_getTransactionCount` be signed by the user when querying the `"pending"` nonce.
+
+To query the `"pending"` nonce, requests must be signed with the user's private key. This is done by sending a JSON-RPC request to the Flashbots Protect RPC endpoint with the following parameters:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "method": "eth_getTransactionCount",
+  "params": [
+    "0xYOUR_ADDRESS",
+    "pending"
+  ],
+  "id": 1
+}
+```
+
+The request is signed and the signature is included in the `X-Flashbots-Signature` header.
+
+### Authentication
+
+To authenticate your request, Flashbots endpoints require you to sign the payload and include the signed payload in the `X-Flashbots-Signature` header of your request.
+
+```curl
+curl -X POST -H "Content-Type: application/json" -H "X-Flashbots-Signature: <public key address>:<signature>" --data '{"jsonrpc":"2.0","method":"eth_getTransactionCount","params":["0xYOUR_ADDRESS","pending"],"id":1}' https://rpc.flashbots.net
+```
+
+The private key of the address your want to query must be used to sign the payload. 
+
+The signature is calculated by taking the [EIP-191](https://eips.ethereum.org/EIPS/eip-191) hash of the json body encoded as UTF-8 bytes. Here's an example using ethers.js:
+
+<Tabs
+defaultValue="ethers.js"
+values={[
+{ label: 'ethers.js', value: 'ethers.js', },
+{ label: 'web3.py', value: 'web3.py' },
+{ label: 'go', value: 'go' },
+]}
+>
+<TabItem value="ethers.js">
+
+```ts
+import {Wallet, utils} from 'ethers';
+
+const privateKey = '0x1234';
+const wallet = new Wallet(privateKey);
+const body =
+  '{"jsonrpc":"2.0","method":"eth_getTransactionCount","params":["0xYOUR_ADDRESS","pending"],"id":1}';
+const signature = wallet.address + ':' + wallet.signMessage(utils.id(body));
+```
+
+</TabItem>
+<TabItem value="web3.py">
+
+```py
+from web3 import Web3
+from eth_account import Account, messages
+
+body = '{"jsonrpc":"2.0","method":"eth_getTransactionCount","params":["0xYOUR_ADDRESS","pending"],"id":1}'
+message = messages.encode_defunct(text=Web3.keccak(text=body).hex())
+signature = Account.from_key(private_key).address + ':' + Account.sign_message(message, private_key).signature.hex()
+```
+
+</TabItem>
+<TabItem value="go">
+
+```go
+body := `{"jsonrpc":"2.0","method":"eth_getTransactionCount","params":["0xYOUR_ADDRESS","pending"],"id":1}`
+hashedBody := crypto.Keccak256Hash([]byte(body)).Hex()
+sig, err := crypto.Sign(accounts.TextHash([]byte(hashedBody)), privKey)
+signature := crypto.PubkeyToAddress(privKey.PublicKey).Hex() + ":" + hexutil.Encode(sig)
+```
+
+</TabItem>
+</Tabs>
+
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 274c93e9..ef85cc47 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -56,6 +56,7 @@ module.exports = {
         'flashbots-protect/mev-share',
         'flashbots-protect/gas-fee-refunds',
         'flashbots-protect/cancellations',
+        'flashbots-protect/nonce-management',
         'flashbots-protect/stuck_transactions',
         'flashbots-protect/large-transactions',
         {