docs: do a run through docs edit some bits

Author: joshstevens19

README.md

@@ -65,36 +65,54 @@ Options:
 We have full documentation https://rrelayer.xyz/getting-started/installation which goes into more detail on how to use
 rrelayer and all the commands available to you.
 
-## Docker
-
-Coming soon.
-
-## Helm Chart
-
-Coming soon.
+## Features
+
+- Config Driven: Define everything in a simple rrelayer.yaml file, making it easy to turn on and off features
+- Multi-Chain Support: Supports all EVM networks
+- Transaction Relaying: Submit transactions to supported blockchain networks efficiently.
+- Transaction Signing: Securely sign transactions using many of the signing providers.
+- Transaction Fee Estimation: Estimate transaction fees for better cost management.
+- Transaction Nonce Management: Handle nonce management to ensure transaction order.
+- Transaction Status Monitoring: Track the status of submitted transactions.
+- Transaction/Signing History: See all the transactions signed by the relayer or messages signed with a deep audit log
+- SDK Integration: Integrate easily with our JS/TS API or rust API or
+- Exposed API: If the SDK is not supported, you can just hit the API directly
+- Extensible Architecture: Easily add support for new blockchain networks with a config update.
+- Configurable Network Policies: Define and enforce network-specific policies for transaction processing.
+- Automated top-ups: Build in background tasks to automatically top up relayers when gas or token funds are becoming low, with safe proxy support.
+- Permissions: Add contract/addresses allowlists to relayers and turn on and off if they can sign messages, typed data, send transactions, and send native ETH.
+- API Keys: Built-in API keys for relayers to allow you to give access to a system without giving access to every part of the rrelayer
+- Webhooks: Notifications built in get notified of the transaction's status every step of the way or if balances are low.
+- Rate Limiting: Built-in rate limiting allowing you to rate limit user transactions allowance by just updating the rrelayer.yaml
+- Flexibility: No hard constraints on features like you can config how often it bumps gas depending on your need. Maybe a liquidation bot may want to bump every block for example.
+- CLI: rrelayer is CLI first, so you can do everything with the command line tool.
+- Full transactions support: rrelayer can send blob transactions and any kind of EVM transaction.
 
 ## What can I use rrelayer for?
 
-* DApp backends: Handle user transactions without wallet management complexity
-* NFT platforms: Automated minting, transfers, and marketplace operations with reliable execution
-* DeFi protocols: Yield farming automation, liquidation bots, and cross-chain operations
-* Enterprise Web3: Simplified blockchain integration for traditional businesses with audit compliance
-* Development workflows: Consistent APIs for local development and comprehensive E2E testing
-* Gasless transactions: Meta-transaction infrastructure for improved user experience
-* Multi-chain applications: Unified transaction interface across different EVM networks
-* High-frequency operations: Advanced queuing system for batch processing and optimization
-* Production infrastructure: Enterprise-grade transaction reliability with comprehensive monitoring
-- Much more...
+- DApp backends: Handle user transactions without wallet management complexity
+- NFT platforms: Automated minting, transfers, and marketplace operations with reliable execution
+- DeFi protocols: Yield farming automation, liquidation bots, and cross-chain operations
+- Enterprise Web3: Simplified blockchain integration for traditional businesses with audit compliance
+- Development workflows: Consistent APIs for local development and comprehensive E2E testing
+- Gasless transactions: Meta-transaction infrastructure for improved user experience
+- Multi-chain applications: Unified transaction interface across different EVM networks
+- High-frequency operations: Advanced queuing system for batch processing and optimization
+- Production infrastructure: Enterprise-grade transaction reliability with comprehensive monitoring
+- Loads more stuff like liquidation bot or trading bots etc
 
 ## SDKs
 
 - Node - https://rrelayer.xyz/integration/sdk/installation/node
 - Rust - https://rrelayer.xyz/integration/sdk/installation/rust
 
-## What networks do you support?
+## Docker
+
+Coming soon.
 
-rrelayer supports any EVM chain out of the box. If you have a custom chain, you can easily add support for it by
-adding the chain's RPC URL to the YAML configuration file and defining the chain ID. No code changes are required.
+## Helm Chart
+
+Coming soon.
 
 ## Building
 

TODO.md

@@ -3,7 +3,5 @@
 ## TODO List
 
 31st September plan:
-- Reread documentation 
-  - TransactionSpeed code snippets tag default
-  - max_gas_price_multiplier: 4
+- Reread documentation
 - Get CI builds / releases working

crates/e2e-tests/config/aws_kms.yaml

@@ -14,6 +14,12 @@ networks:
       - http://127.0.0.1:8545
     block_explorer_url: http://localhost:8545
     enable_sending_blobs: true
+    max_gas_price_multiplier: 4
+    gas_bump_blocks_every:
+      slow: 10
+      medium: 5
+      fast: 4
+      super_fast: 2
     automatic_top_up:
       from:
         # safe: "0xcfe267de230a234c5937f18f239617b7038ec271" # NEED TO TEST

crates/e2e-tests/config/aws_secret_manager.yaml

@@ -14,6 +14,12 @@ networks:
     provider_urls:
       - http://127.0.0.1:8545
     block_explorer_url: http://localhost:8545
+    max_gas_price_multiplier: 4
+    gas_bump_blocks_every:
+      slow: 10
+      medium: 5
+      fast: 4
+      super_fast: 2
     enable_sending_blobs: true
     automatic_top_up:
       from:

crates/e2e-tests/config/gcp_secret_manager.yaml

@@ -10,6 +10,12 @@ networks:
     provider_urls:
       - http://127.0.0.1:8545
     block_explorer_url: http://localhost:8545
+    max_gas_price_multiplier: 4
+    gas_bump_blocks_every:
+      slow: 10
+      medium: 5
+      fast: 4
+      super_fast: 2
     enable_sending_blobs: true
     automatic_top_up:
       from:

crates/e2e-tests/config/privy.yaml

@@ -9,6 +9,12 @@ networks:
   provider_urls:
     - http://127.0.0.1:8545
   block_explorer_url: http://localhost:8545
+  max_gas_price_multiplier: 4
+  gas_bump_blocks_every:
+    slow: 10
+    medium: 5
+    fast: 4
+    super_fast: 2
   enable_sending_blobs: true
   automatic_top_up:
     from:

crates/e2e-tests/config/raw.yaml

@@ -12,6 +12,12 @@ networks:
   provider_urls:
     - http://127.0.0.1:8545
   block_explorer_url: http://localhost:8545
+  max_gas_price_multiplier: 4
+  gas_bump_blocks_every:
+    slow: 10
+    medium: 5
+    fast: 4
+    super_fast: 2
   enable_sending_blobs: true
   automatic_top_up:
     from:

crates/e2e-tests/config/turnkey.yaml

@@ -11,6 +11,12 @@ networks:
     provider_urls:
       - http://127.0.0.1:8545
     block_explorer_url: http://localhost:8545
+    max_gas_price_multiplier: 4
+    gas_bump_blocks_every:
+      slow: 10
+      medium: 5
+      fast: 4
+      super_fast: 2
     enable_sending_blobs: true
     automatic_top_up:
       from:

crates/sdk/README.md

@@ -14,6 +14,42 @@ Web3 applications with enterprise-grade reliability and focus exclusively on you
 logic. rrelayer out of the box gives you transaction relay, message signing, automated
 gas management, and real-time monitoring through intuitive APIs.
 
+## Features
+
+- Config Driven: Define everything in a simple rrelayer.yaml file, making it easy to turn on and off features
+- Multi-Chain Support: Supports all EVM networks
+- Transaction Relaying: Submit transactions to supported blockchain networks efficiently.
+- Transaction Signing: Securely sign transactions using many of the signing providers.
+- Transaction Fee Estimation: Estimate transaction fees for better cost management.
+- Transaction Nonce Management: Handle nonce management to ensure transaction order.
+- Transaction Status Monitoring: Track the status of submitted transactions.
+- Transaction/Signing History: See all the transactions signed by the relayer or messages signed with a deep audit log
+- SDK Integration: Integrate easily with our JS/TS API or rust API or
+- Exposed API: If the SDK is not supported, you can just hit the API directly
+- Extensible Architecture: Easily add support for new blockchain networks with a config update.
+- Configurable Network Policies: Define and enforce network-specific policies for transaction processing.
+- Automated top-ups: Build in background tasks to automatically top up relayers when gas or token funds are becoming low, with safe proxy support.
+- Permissions: Add contract/addresses allowlists to relayers and turn on and off if they can sign messages, typed data, send transactions, and send native ETH.
+- API Keys: Built-in API keys for relayers to allow you to give access to a system without giving access to every part of the rrelayer
+- Webhooks: Notifications built in get notified of the transaction's status every step of the way or if balances are low.
+- Rate Limiting: Built-in rate limiting allowing you to rate limit user transactions allowance by just updating the rrelayer.yaml
+- Flexibility: No hard constraints on features like you can config how often it bumps gas depending on your need. Maybe a liquidation bot may want to bump every block for example.
+- CLI: rrelayer is CLI first, so you can do everything with the command line tool.
+- Full transactions support: rrelayer can send blob transactions and any kind of EVM transaction.
+
+## What can I use rrelayer for?
+
+- DApp backends: Handle user transactions without wallet management complexity
+- NFT platforms: Automated minting, transfers, and marketplace operations with reliable execution
+- DeFi protocols: Yield farming automation, liquidation bots, and cross-chain operations
+- Enterprise Web3: Simplified blockchain integration for traditional businesses with audit compliance
+- Development workflows: Consistent APIs for local development and comprehensive E2E testing
+- Gasless transactions: Meta-transaction infrastructure for improved user experience
+- Multi-chain applications: Unified transaction interface across different EVM networks
+- High-frequency operations: Advanced queuing system for batch processing and optimization
+- Production infrastructure: Enterprise-grade transaction reliability with comprehensive monitoring
+- Loads more stuff like liquidation bot or trading bots etc
+
 ## Usage
 
 ### Create Client And Authentication

documentation/rrelayer/docs/pages/config/api-config.mdx

@@ -31,19 +31,19 @@ api_config:
   authentication_username: "${RRELAYER_AUTH_USERNAME}" // [!code focus]
 ```
 
-### authentication_username
+### authentication_password
 
 :::info
 rrelayer users basic authentication for the API.
 :::
 
-The basic authentication username
+The basic authentication password
 
 ```yaml [rrelayer.yaml]
 name: first-rrelayer
 description: "my first rrelayer"
 api_config:
   port: 3000
-  authentication_username: "${RRELAYER_AUTH_USERNAME}" // [!code focus]
+  authentication_username: "${RRELAYER_AUTH_USERNAME}"
   authentication_password: "${RRELAYER_AUTH_PASSWORD}" // [!code focus]
 ```