From c928bc64dcde020b9fa2a996a4f20a78b9065549 Mon Sep 17 00:00:00 2001
From: Dhai <dhaiwatpandya@gmail.com>
Date: Sat, 28 Dec 2024 07:13:51 +0530
Subject: [PATCH] add docs

---
 docs/docs/packages/plugins.md                | 31 ++++++++++++++++++++
 packages/plugin-fuel/src/actions/transfer.ts |  2 +-
 2 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/docs/docs/packages/plugins.md b/docs/docs/packages/plugins.md
index 807dfc8d71..8e13cf7062 100644
--- a/docs/docs/packages/plugins.md
+++ b/docs/docs/packages/plugins.md
@@ -603,6 +603,37 @@ console.log("Webhook creation response:", response);
 - **Validation**: Always validate input parameters to ensure compliance with expected formats and supported networks.
 - **Error Handling**: Monitor logs for errors during webhook creation and adjust retry logic as needed.
 
+### 10. Fuel Plugin (`@elizaos/plugin-fuel`)
+
+The Fuel plugin provides an interface to the Fuel Ignition blockchain.
+
+**Actions:**
+
+1. `TRANSFER_FUEL_ETH` - Transfer ETH to a given Fuel address. - **Inputs**: - `toAddress` (string): The Fuel address to transfer ETH to. - `amount` (string): The amount of ETH to transfer. - **Outputs**: Confirmation message with transaction details. - **Example**:
+   `json
+{
+    "toAddress": "0x8F8afB12402C9a4bD9678Bec363E51360142f8443FB171655eEd55dB298828D1",
+    "amount": "0.00001"
+}
+`
+   **Setup and Configuration:**
+
+1. **Configure the Plugin**
+   Add the plugin to your character's configuration:
+
+    ```typescript
+    import { fuelPlugin } from "@eliza/plugin-fuel";
+
+    const character = {
+        plugins: [fuelPlugin],
+    };
+    ```
+
+1. **Required Configurations**
+   Set the following environment variables or runtime settings:
+
+    - `FUEL_WALLET_PRIVATE_KEY`: Private key for secure transactions
+
 ### Writing Custom Plugins
 
 Create a new plugin by implementing the Plugin interface:
diff --git a/packages/plugin-fuel/src/actions/transfer.ts b/packages/plugin-fuel/src/actions/transfer.ts
index a244f9fa05..9ff5e2b914 100644
--- a/packages/plugin-fuel/src/actions/transfer.ts
+++ b/packages/plugin-fuel/src/actions/transfer.ts
@@ -105,5 +105,5 @@ export const transferAction: Action = {
             },
         ],
     ],
-    similes: ["SEND_FUEL_ETH", "FUEL_TRANSFER", "SEND_ETH"],
+    similes: ["TRANSFER_FUEL_ETH"],
 };